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

KYC Status

GET
/api/v1/transformer/entity/kyc/{entityId}
This endpoint retrieves the current verification status for a specific entity across all available routing providers.

Request

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

Responses

🟢200OK
application/json
KYC status retrieved successfully
Body

🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/transformer/entity/kyc/'
Response Response Example
200 - Example 1
{
    "success": true,
    "message": "KYC status retrieved successfully",
    "data": {
        "status": [
            {
                "routingId": "provider123",
                "supportedRoutes": [
                    {
                        "from": {
                            "jurisdictionId": "US",
                            "jurisdictionName": "United States",
                            "jurisdictionType": "country",
                            "currency": "USD"
                        },
                        "to": {
                            "jurisdictionId": "UK",
                            "jurisdictionName": "United Kingdom",
                            "jurisdictionType": "country",
                            "currency": "GBP"
                        }
                    }
                ],
                "kycStatus": "not_started",
                "routingEnabled": true,
                "kycFees": {
                    "network": "Solana Mainnet (Chain ID: 101)",
                    "currency": "USDC",
                    "tokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGcKZwyTDt1v",
                    "amount": 25,
                    "toWalletAddress": "5FhWg3kXmAS2r6pNZ5C8JNz3xZyEZaJgHSzBGta3sVu",
                    "paymentReceived": true
                }
            }
        ]
    }
}
Modified at 2025-11-11 17:09:57
Previous
Entity By Email
Next
KYC Requirements
Built with