> ## Documentation Index > Fetch the complete documentation index at: https://docs.hifi.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve KYC status > Get the user's latest KYC status for a specific rail after a KYC submission. If no KYC submission has been made for the rail, it will have an `INACTIVE` status. The Get KYC Status endpoint provides the current KYC status of a rail, including details on any invalid or incomplete fields that may require updates. To address any invalid or incomplete fields, use the [Update KYC endpoint](https://docs.hifi.com/api-reference/kyc/update-kyc-information), and then resubmit the data using the [Submit KYC endpoint](https://docs.hifi.com/api-reference/kyc/submit-kyc). ## OpenAPI ````yaml https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/status openapi: 3.0.0 info: title: Hifi API version: 2.0.0 description: API documentation for Hifi servers: - url: https://production.hifibridge.com description: Production server - url: https://sandbox.hifibridge.com description: Sandbox server security: - bearerAuth: [] tags: - name: Common description: Common endpoints - name: User description: User endpoints - name: Kyc description: Kyc endpoints - name: Wallet description: Wallet endpoints - name: Account description: Account endpoints - name: External Account description: External Account endpoints for managing beneficiary bank accounts - name: Fiat Account description: Fiat Account endpoints - name: Virtual Account description: Virtual Account endpoints - name: Onramp description: Onramp endpoints - name: Offramp description: Offramp endpoints - name: Orchestration Address description: >- Orchestration Address endpoints — persistent on-chain wallets that automatically off-ramp incoming stablecoin deposits to a USD bank account - name: Crypto Transfer description: Crypto Transfer endpoints - name: Cross-Chain Bridge description: Cross-Chain Bridge endpoints - name: Token Swap description: Token Swap endpoints - name: Canton Offers description: Canton Offers endpoints - name: Transfer Rules description: Transfer approval rules and configuration - name: Transfer Approvals description: Transfer approval workflow and admin actions - name: File description: File endpoints - name: Reporting description: Reporting and metrics endpoints paths: /v2/users/{userId}/kyc/status: get: tags: - Kyc summary: Retrieve KYC status description: > Get the user's latest KYC status for a specific rail after a KYC submission. If no KYC submission has been made for the rail, it will have an `INACTIVE` status. The Get KYC Status endpoint provides the current KYC status of a rail, including details on any invalid or incomplete fields that may require updates. To address any invalid or incomplete fields, use the [Update KYC endpoint](https://docs.hifi.com/api-reference/kyc/update-kyc-information), and then resubmit the data using the [Submit KYC endpoint](https://docs.hifi.com/api-reference/kyc/submit-kyc). parameters: - $ref: '#/components/parameters/UserIdPathParameter' - $ref: '#/components/parameters/RailsTypeOptionalParameter' responses: '200': $ref: '#/components/responses/KycStatusResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' components: parameters: UserIdPathParameter: name: userId in: path schema: type: string description: ID of the user required: true RailsTypeOptionalParameter: name: rails in: query schema: $ref: '#/components/schemas/RailsEnum' description: The type of rail. required: false responses: KycStatusResponse: description: Success content: application/json: schema: oneOf: - $ref: '#/components/schemas/UsdRailIndividualKycStatusObject' - $ref: '#/components/schemas/UsdRailBusinessKycStatusObject' - $ref: '#/components/schemas/SouthAmericaRailKycStatusObject' - $ref: '#/components/schemas/AfricaGeneralRailKycStatusObject' - $ref: '#/components/schemas/AfricaNigeriaRailKycStatusObject' - $ref: '#/components/schemas/GlobalNetworkRailKycStatusObject' examples: KycStatusObjectUSDInactiveExample: $ref: '#/components/examples/KycStatusObjectUSDInactiveExample' KycStatusObjectUSDPendingIndividualExample: $ref: '#/components/examples/KycStatusObjectUSDPendingIndividualExample' KycStatusObjectUSDIncompleteBusinessExample: $ref: >- #/components/examples/KycStatusObjectUSDIncompleteBusinessExample KycStatusObjectUSDActiveBusinessExample: $ref: '#/components/examples/KycStatusObjectUSDActiveBusinessExample' KycStatusObjectSouthAmericaPendingExample: $ref: '#/components/examples/KycStatusObjectSouthAmericaPendingExample' KycStatusObjectSouthAmericaActiveExample: $ref: '#/components/examples/KycStatusObjectSouthAmericaActiveExample' KycStatusObjectAfricaGeneralActiveExample: $ref: '#/components/examples/KycStatusObjectAfricaGeneralActiveExample' KycStatusObjectAfricaNigeriaActiveExample: $ref: '#/components/examples/KycStatusObjectAfricaNigeriaActiveExample' KycStatusObjectGlobalNetworkActiveExample: $ref: '#/components/examples/KycStatusObjectGlobalNetworkActiveExample' UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' NotFoundResponse: description: Resource not found content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: string message: type: string InternalServerErrorResponse: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' schemas: RailsEnum: type: string description: The type of rail. enum: - USD - SOUTH_AMERICA_STANDARD - AFRICA_GENERAL - AFRICA_NIGERIA - GLOBAL_NETWORK - USD_FIAT UsdRailIndividualKycStatusObject: type: object title: Kyc Status Object (USD - Individual) properties: status: $ref: '#/components/schemas/KycStatusEnum' message: type: string reviewResult: $ref: '#/components/schemas/ReviewResultObject' details: $ref: '#/components/schemas/ReviewDetailsIndividualObject' required: - status - message - reviewResult - details UsdRailBusinessKycStatusObject: type: object title: Kyc Status Object (USD - Business) properties: status: $ref: '#/components/schemas/KycStatusEnum' message: type: string reviewResult: $ref: '#/components/schemas/ReviewResultObject' details: $ref: '#/components/schemas/ReviewDetailsBusinessObject' required: - status - message - reviewResult - details SouthAmericaRailKycStatusObject: type: object title: KYC Status Object (SOUTH_AMERICA_STANDARD) properties: status: $ref: '#/components/schemas/KycStatusEnum' warnings: type: array message: type: string limit: type: object properties: daily: type: number monthly: type: number perTransaction: type: number onRamp: type: object properties: brl: type: object properties: pix: $ref: '#/components/schemas/KycRailStatusObject' offRamp: type: object properties: brl: type: object properties: pix: $ref: '#/components/schemas/KycRailStatusObject' mxn: type: object properties: spei: $ref: '#/components/schemas/KycRailStatusObject' cop: type: object properties: achCop: $ref: '#/components/schemas/KycRailStatusObject' ars: type: object properties: transfers: $ref: '#/components/schemas/KycRailStatusObject' AfricaGeneralRailKycStatusObject: type: object title: Kyc Status Object (AFRICA_GENERAL) properties: status: $ref: '#/components/schemas/KycStatusEnum' warnings: type: array message: type: string onRamp: type: object properties: kes: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' ghs: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' tzs: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' ugx: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' bwp: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' xaf: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' momo: $ref: '#/components/schemas/KycRailStatusObject' mwk: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' momo: $ref: '#/components/schemas/KycRailStatusObject' rwf: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' zmw: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' momo: $ref: '#/components/schemas/KycRailStatusObject' xof: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' offRamp: type: object properties: kes: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' momo: $ref: '#/components/schemas/KycRailStatusObject' zar: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' ghs: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' tzs: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' ugx: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' bwp: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' xaf: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' mwk: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' rwf: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' zmw: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' xof: type: object properties: momo: $ref: '#/components/schemas/KycRailStatusObject' required: - status - warnings - message - onRamp - offRamp AfricaNigeriaRailKycStatusObject: type: object title: Kyc Status Object (AFRICA_NIGERIA) properties: status: $ref: '#/components/schemas/KycStatusEnum' warnings: type: array message: type: string onRamp: type: object properties: ngn: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' offRamp: type: object properties: ngn: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' required: - status - warnings - message - onRamp - offRamp GlobalNetworkRailKycStatusObject: type: object title: Kyc Status Object (GLOBAL_NETWORK) properties: status: $ref: '#/components/schemas/KycStatusEnum' warnings: type: array message: type: string onRamp: type: object additionalProperties: false offRamp: type: object additionalProperties: false properties: brl: type: object properties: pix: $ref: '#/components/schemas/KycRailStatusObject' hkd: type: object properties: wire: $ref: '#/components/schemas/KycRailStatusObject' mxn: type: object properties: spei: $ref: '#/components/schemas/KycRailStatusObject' ngn: type: object properties: bank: $ref: '#/components/schemas/KycRailStatusObject' required: - status - warnings - message - onRamp - offRamp Unauthorized: type: object properties: code: type: integer description: Error code error: type: string description: Error type errorDetails: type: string description: Detailed error message InternalServerError: type: object properties: code: type: integer description: Error code error: type: string description: Error type errorDetails: type: string description: Detailed error message KycStatusEnum: type: string enum: - INACTIVE - CREATED - PENDING - INCOMPLETE - RFI_PENDING - ACTIVE - REJECTED - CONTACT_SUPPORT description: > Kyc Status - `INACTIVE`: No KYC submission has been made. - `CREATED`: KYC application has been submitted. - `PENDING`: Review in progress. - `RFI_PENDING`: An RFI (Request for Information) email has been sent and is pending user response. - `INCOMPLETE`: RFI or resubmission required. - `ACTIVE`: User approved and onboarded. - `REJECTED`: KYC application rejected. - `CONTACT_SUPPORT`: Unexpected issue encountered during KYC review. ReviewResultObject: type: object title: Review Result properties: reviewAnswer: type: string enum: - APPROVED - DECLINED reviewRejectType: type: string enum: - FINAL - RETRY rejectReasons: type: array items: type: string comment: type: string ReviewDetailsIndividualObject: type: object title: Review Details Individual properties: personalInfo: $ref: '#/components/schemas/VerificationStatusObject' identity: $ref: '#/components/schemas/DocumentVerificationStatusObject' proofOfAddress: $ref: '#/components/schemas/DocumentVerificationStatusObject' questionnaire: $ref: '#/components/schemas/VerificationStatusObject' ReviewDetailsBusinessObject: type: object title: Review Details Business Object properties: companyInfo: $ref: '#/components/schemas/VerificationStatusObject' companyDocuments: $ref: '#/components/schemas/DocumentVerificationStatusObject' questionnaire: $ref: '#/components/schemas/VerificationStatusObject' ultimateBeneficialOwners: type: object properties: reviewResult: $ref: '#/components/schemas/ReviewResultObject' details: type: array items: allOf: - type: object properties: id: type: string format: uuid description: UBO ID. - $ref: '#/components/schemas/UsdRailIndividualKycStatusObject' KycRailStatusObject: type: object properties: status: type: string warnings: type: array message: type: string VerificationStatusObject: type: object title: Verification Status properties: reviewResult: $ref: '#/components/schemas/ReviewResultObject' DocumentVerificationStatusObject: type: object title: Document Verification Status properties: reviewResult: $ref: '#/components/schemas/ReviewResultObject' details: type: array items: type: object properties: id: type: string format: uuid type: type: string description: Document type. subType: type: string description: Document subType. reviewResult: $ref: '#/components/schemas/ReviewResultObject' examples: KycStatusObjectUSDInactiveExample: summary: KYC Status Object (USD - INACTIVE) value: status: INACTIVE message: The rail is not active. KycStatusObjectUSDPendingIndividualExample: summary: KYC Status Object (USD - Individual - PENDING) value: status: PENDING message: '' reviewResult: {} details: identity: reviewResult: {} details: - id: e423fa6b-6d05-4b21-8797-ba8c75effaa4 type: ID_CARD subType: FRONT_SIDE reviewResult: {} - id: c819c689-7e50-4c39-bec7-76875a078495 type: ID_CARD subType: BACK_SIDE reviewResult: {} questionnaire: reviewResult: {} personalInfo: reviewResult: {} proofOfAddress: reviewResult: {} details: - id: 7bc43187-e7c2-496c-bd14-30b71cadadc3 type: PROOF_OF_ADDRESS subType: SINGLE_SIDE reviewResult: {} KycStatusObjectUSDIncompleteBusinessExample: summary: KYC Status Object (USD - Business - INCOMPLETE) value: status: INCOMPLETE message: '' reviewResult: reviewAnswer: DECLINED reviewRejectType: RETRY rejectReasons: - UNFILLED_ID comment: '' details: companyInfo: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' questionnaire: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' companyDocuments: reviewResult: reviewAnswer: DECLINED reviewRejectType: RETRY rejectReasons: [] comment: '' details: - id: 04f809a1-e9fc-45d6-9c1f-b308cfb19c96 type: PROOF_OF_ADDRESS subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' - id: b0436bee-0e80-46d3-98a2-6d58183eb84f type: INFORMATION_STATEMENT subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' - id: d9f38450-ec16-4a4b-bf69-f8c88bb73a94 type: SHAREHOLDER_REGISTRY subType: SINGLE_SIDE reviewResult: reviewAnswer: DECLINED reviewRejectType: RETRY rejectReasons: - UNFILLED_ID comment: |- This document is not accepted. - The document is missing key company identification details like the registration number or company name. Please upload a document that includes this information to verify its relevance. - id: 7a9dc485-3216-47fd-baa4-a7ab4085b723 type: INCORPORATION_CERT subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' ultimateBeneficialOwners: reviewResult: {} details: - id: 74441b74-caab-5f74-8e24-3fcee83faac8 status: INCOMPLETE message: '' reviewResult: reviewAnswer: DECLINED reviewRejectType: RETRY rejectReasons: - SCREENSHOTS - UNSATISFACTORY_PHOTOS comment: '' details: identity: reviewResult: reviewAnswer: DECLINED reviewRejectType: RETRY rejectReasons: [] comment: >- Screenshots aren’t accepted. Please upload a live photo of the document. details: - id: b4534db5-b759-4a4e-ad29-8ab5a1257936 type: PASSPORT subType: SINGLE_SIDE reviewResult: reviewAnswer: DECLINED reviewRejectType: RETRY rejectReasons: - SCREENSHOTS - UNSATISFACTORY_PHOTOS comment: >- Screenshots aren’t accepted. Please upload a live photo of the document. personalInfo: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' KycStatusObjectUSDActiveBusinessExample: summary: KYC Status Object (USD - Business - ACTIVE) value: status: ACTIVE message: '' reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' details: companyInfo: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' questionnaire: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' companyDocuments: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' details: - id: 04f809a1-e9fc-45d6-9c1f-b308cfb19c96 type: PROOF_OF_ADDRESS subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' - id: b0436bee-0e80-46d3-98a2-6d58183eb84f type: INFORMATION_STATEMENT subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' - id: d9f38450-ec16-4a4b-bf69-f8c88bb73a94 type: SHAREHOLDER_REGISTRY subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' - id: 7a9dc485-3216-47fd-baa4-a7ab4085b723 type: INCORPORATION_CERT subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' ultimateBeneficialOwners: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' details: - id: 74441b74-caab-5f74-8e24-3fcee83faac8 status: ACTIVE message: '' reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' details: identity: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' details: - id: b4534db5-b759-4a4e-ad29-8ab5a1257936 type: PASSPORT subType: SINGLE_SIDE reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' personalInfo: reviewResult: reviewAnswer: APPROVED reviewRejectType: '' rejectReasons: [] comment: '' KycStatusObjectSouthAmericaPendingExample: summary: KYC Status Object (SOUTH_AMERICA_STANDARD - PENDING) value: status: PENDING warnings: [] message: '' limit: {} onRamp: brl: pix: status: PENDING warnings: [] message: '' offRamp: brl: pix: status: PENDING warnings: [] message: '' mxn: spei: status: PENDING warnings: [] message: '' cop: achCop: status: PENDING warnings: [] message: '' ars: transfers: status: PENDING warnings: [] message: '' KycStatusObjectSouthAmericaActiveExample: summary: KYC Status Object (SOUTH_AMERICA_STANDARD - ACTIVE) value: status: ACTIVE warnings: [] message: '' limit: daily: 50000 monthly: 100000 perTransaction: 10000 onRamp: brl: pix: status: ACTIVE warnings: [] message: '' offRamp: brl: pix: status: ACTIVE warnings: [] message: '' mxn: spei: status: ACTIVE warnings: [] message: '' cop: achCop: status: ACTIVE warnings: [] message: '' ars: transfers: status: ACTIVE warnings: [] message: '' KycStatusObjectAfricaGeneralActiveExample: summary: KYC Status Object (AFRICA_GENERAL - ACTIVE) value: status: ACTIVE warnings: [] message: '' onRamp: kes: momo: status: ACTIVE warnings: [] message: '' ghs: momo: status: ACTIVE warnings: [] message: '' tzs: bank: status: ACTIVE warnings: [] message: '' ugx: bank: status: ACTIVE warnings: [] message: '' bwp: bank: status: ACTIVE warnings: [] message: '' xaf: bank: status: ACTIVE warnings: [] message: '' momo: status: ACTIVE warnings: [] message: '' mwk: bank: status: ACTIVE warnings: [] message: '' momo: status: ACTIVE warnings: [] message: '' rwf: bank: status: ACTIVE warnings: [] message: '' zmw: bank: status: ACTIVE warnings: [] message: '' momo: status: ACTIVE warnings: [] message: '' xof: momo: status: ACTIVE warnings: [] message: '' offRamp: kes: bank: status: ACTIVE warnings: [] message: '' momo: status: ACTIVE warnings: [] message: '' zar: bank: status: ACTIVE warnings: [] message: '' gns: momo: status: ACTIVE warnings: [] message: '' tzs: momo: status: ACTIVE warnings: [] message: '' ugx: momo: status: ACTIVE warnings: [] message: '' bwp: momo: status: ACTIVE warnings: [] message: '' xaf: momo: status: ACTIVE warnings: [] message: '' mwk: momo: status: ACTIVE warnings: [] message: '' rwf: momo: status: ACTIVE warnings: [] message: '' zmw: momo: status: ACTIVE warnings: [] message: '' xof: momo: status: ACTIVE warnings: [] message: '' KycStatusObjectAfricaNigeriaActiveExample: summary: KYC Status Object (AFRICA_NIGERIA - ACTIVE) value: status: ACTIVE warnings: [] message: '' onRamp: ngn: bank: status: ACTIVE warnings: [] message: '' offRamp: ngn: bank: status: ACTIVE warnings: [] message: '' KycStatusObjectGlobalNetworkActiveExample: summary: KYC Status Object (GLOBAL_NETWORK - ACTIVE) value: status: ACTIVE warnings: [] message: '' onRamp: {} offRamp: brl: pix: status: ACTIVE warnings: [] message: '' hkd: wire: status: ACTIVE warnings: [] message: '' mxn: spei: status: ACTIVE warnings: [] message: '' ngn: bank: status: ACTIVE warnings: [] message: '' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````