Zynk
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
  1. Transformer: Entity
  • Transformer - Cross border transfer
    • Transformer: Entity
      • Create Entity
        POST
      • Entities
        GET
      • Entity By ID
        GET
      • Entity By Email
        GET
      • KYC Status
        GET
      • KYC Requirements
        GET
      • Submit KYC/KYB
        POST
      • Get KYC Documents
        GET
    • Transformer: Accounts
      • External Accounts
        • Generate Plaid Link Token
        • Update Plaid Link Token
        • Get External Account Payload Requirements
        • Add External Account
        • Enable External Account
        • Disable External Account
        • Delete External Account
        • Get External Account by ID
        • Get External Accounts
      • Funding Accounts
        • Create Funding Account
        • Activate Funding Account
        • Deactivate Funding Account
        • Funding Account by ID
        • All Funding Accounts
      • Entity Accounts (Deprecated)
        • Add Entity Account
        • Remove Entity Account
        • Get Entity Account
        • Get Entity Accounts
    • Transformer: Transfers
      • Simulate
      • Transfer
      • All transfers for partner
      • Transfer by execution ID
    • Transformer: Utility
      • Partner Payments Account Balance
      • Partner Payments Deposit
      • Get Jurisdictions
    • Webhooks
      • Get Webhook Events History
      • Registered Webhook URL
      • Register or Update Webhook URL
  • Transporter - Automated Liquidity Manager
    • ALM Market
      • Create Reserve Quote
      • Accept Reserve Frame
      • Get Active Reserves
      • Get All Reserves
    • Transaction Details by ID, Partner Transaction ID, or Transaction Hash
      GET
    • Transaction Details
      GET
    • Transaction Details by ID
      GET
    • Partner Details
      GET
    • Initiate Transaction
      POST
    • Replenish Fee Quote
      POST
    • Quote Fulfilled
      POST
    • Replenish Initiate
      POST
    • Replenish Batch Transaction
      POST
    • Replenish Fee Quote Batch
      POST
  • Teleport - Pay-In Accounts
    • Create Teleport Route
      POST
    • Update Teleport Destination
      POST
    • Toggle Teleport Status
      POST
    • Teleport Details
      GET
    • Teleport Routes by Entity
      GET
  • Continuum - Wallet Infrastructure
    • Authentication
      • Register primary authentication
    • Wallet Management
      • Prepare wallet creation challenge (Step 1)
      • Submit wallet creation activity (Step 2)
    • Account Management
      • Prepare account creation challenge (Step 1)
      • Submit account creation activity (Step 2)
    • Passkey Management
      • Prepare passkey registration (Step 1)
      • Submit passkey registration (Step 2)
      • Get passkey authenticators
      • Prepare passkey deletion (Step 1)
      • Submit passkey deletion (Step 2)
    • Wallet Information
      • Get wallet details
      • Get wallet balances
      • Get transactions for address
    • Sessions
      • Initiate OTP delivery
      • Start authentication session
  • Archive
    • KYC Documents
    • Prepaid KYC Balance
    • Prepaid KYC Deposit
  1. Transformer: Entity

Get KYC Documents

GET
/api/v1/transformer/entity/{entityId}/kyc/documents
Retrieve all KYC documents associated with a specific entity.
Path Parameters
{entity_id}: The unique identifier of the entity for which you want to retrieve KYC documents (e.g., entity_e8dc5686_9f24_4c1c_8209_5fb9ae411575).
Query Parameters
routingId (Optional): This parameter allows you to specify a particular routing ID.
If a routingId is provided, the KYC documents will be fetched specifically for that routing ID.
If routingId is not provided, the documents will be returned for the KYC associated with the AED corridor by default.
Example with routingId:
routingId=infrap_b1c912d4_bee1_4d1a_bef0_93c865d741cd

Request

Authorization
Add parameter in header
x-api-token
Example:
x-api-token: ********************
Path Params

Query Params

Responses

🟢200OK
application/json
List of KYC documents for the entity
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/transformer/entity/entity_e8dc5686_9f24_4c1c_8209_5fb9ae411575/kyc/documents?routingId=infrap_b1c912d4_bee1_4d1a_bef0_93c865d741cd'
Response Response Example
{
    "success": true,
    "data": {
        "name": {
            "first": "ALEXANDER J",
            "middle": null,
            "last": "SAMPLE",
            "full": "ALEXANDER J SAMPLE"
        },
        "address": {
            "street": "600 CALIFORNIA STREET",
            "street2": "22 b",
            "city": "SAN FRANCISCO",
            "subdivision": "CA",
            "postal_code": "94109",
            "country_code": "US"
        },
        "dateOfBirth": "1977-07-17",
        "phoneNumber": "+12345678900",
        "emailAddress": "alex.sample@gmail.com",
        "files": [
            {
                "type": "drivers_license_back",
                "fileName": "drivers_license_back.jpg",
                "contentType": "image/jpeg",
                "downloadUrl": "https://dummy-link.com/drivers_license_back.jpg"
            },
            {
                "type": "drivers_license_front",
                "fileName": "drivers_license_front.jpg",
                "contentType": "image/jpeg",
                "downloadUrl": "https://dummy-link.com/drivers_license_front.jpg"
            },
            {
                "type": "selfie_left",
                "fileName": "selfie_left.jpg",
                "contentType": "image/jpeg",
                "downloadUrl": "https://dummy-link.com/selfie_left.jpg"
            },
            {
                "type": "selfie_right",
                "fileName": "selfie_right.jpg",
                "contentType": "image/jpeg",
                "downloadUrl": "https://dummy-link.com/selfie_right.jpg"
            },
            {
                "type": "selfie",
                "fileName": "selfie.jpg",
                "contentType": "image/jpeg",
                "downloadUrl": "https://dummy-link.com/selfie.jpg"
            }
        ],
        "identificationNumbers": [
            {
                "type": "drivers_license",
                "issuingCountryCode": "US",
                "identificationNumber": "I1234562"
            },
            {
                "type": "social_security_number",
                "issuingCountryCode": "US",
                "identificationNumber": "123-12-1234"
            }
        ]
    }
}
Modified at 2025-11-11 17:21:52
Previous
Submit KYC/KYB
Next
Generate Plaid Link Token
Built with