Zynk
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
  1. External Accounts
  • Transformer - Cross border transfer
    • Transformer: Entity
      • Create Entity
      • Entities
      • Entity By ID
      • Entity By Email
      • KYC Status
      • KYC Requirements
      • Submit KYC/KYB
      • Get KYC Documents
    • Transformer: Accounts
      • External Accounts
        • Generate Plaid Link Token
          POST
        • Update Plaid Link Token
          POST
        • Get External Account Payload Requirements
          GET
        • Add External Account
          POST
        • Enable External Account
          POST
        • Disable External Account
          POST
        • Delete External Account
          POST
        • Get External Account by ID
          GET
        • Get External Accounts
          GET
      • 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
    • Update Teleport Destination
    • Toggle Teleport Status
    • Teleport Details
    • Teleport Routes by Entity
  • 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. External Accounts

Get External Account Payload Requirements

GET
/api/v1/transformer/accounts/{entityId}/external_account_payload_requirements/{jurisdictionId}
Returns the JSON Schema Draft-07 and uiSchema for the required payload for adding an external account (fiat or blockchain) for a given jurisdiction. The schema describes the structure and validation rules for the account (fiat) or wallet (blockchain) object in the Add External Account API.

Request

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

Query Params

Responses

🟢200OK
application/json
Successfully fetched requirements schema.
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/transformer/accounts/entity_c2f742c5_ea24_405f_a329_c73c0b3234a2/external_account_payload_requirements/jurisdiction_39fcac47_15b5_4fd0_af4d_3ea46b41fbf7?accountType=deposit&accountOwnershipType=first_party'
Response Response Example
200 - Basic Example (ARS)
{
    "success": true,
    "data": {
        "message": "Account requirements fetched successfully",
        "schema": {
            "jsonSchema": {
                "$schema": "http://json-schema.org/draft-07/schema#",
                "id": "infrap_30f8aa4e_0817_4b95_b61e_74003ab0c05f",
                "jurisdiction": "jurisdiction_fe5de4d3_c068_439e_bc15_25a9d341e3e0",
                "title": "ARS (Argentina) Account Requirements",
                "description": "Account requirements schema for ARS in Argentina",
                "type": "object",
                "required": [
                    "documentType",
                    "documentNumber",
                    "accountType",
                    "accountNumber",
                    "beneficiaryType",
                    "phone",
                    "phoneCode",
                    "payerName",
                    "street",
                    "city",
                    "state",
                    "dob",
                    "postalCode",
                    "bankCode"
                ],
                "properties": {
                    "documentType": {
                        "type": "string",
                        "enum": [
                            "DNI",
                            "CUIT"
                        ],
                        "title": "Document Type",
                        "description": "Type of identification document.",
                        "errorMessage": {
                            "enum": "Must be either 'DNI' or 'CUIT'"
                        }
                    },
                    "documentNumber": {
                        "type": "string",
                        "minLength": 8,
                        "maxLength": 11,
                        "pattern": "^[A-Z0-9]+$",
                        "title": "Document Number",
                        "description": "8-11 uppercase alphanumeric characters.",
                        "errorMessage": {
                            "minLength": "Must be at least 8 characters",
                            "maxLength": "Must be at most 11 characters",
                            "pattern": "Must be uppercase alphanumeric (A-Z, 0-9)"
                        }
                    },
                    "accountType": {
                        "type": "string",
                        "enum": [
                            "checking",
                            "savings"
                        ],
                        "title": "Account Type",
                        "description": "Type of the account.",
                        "errorMessage": {
                            "enum": "Must be either 'checking' or 'savings'"
                        }
                    },
                    "accountNumber": {
                        "type": "string",
                        "minLength": 22,
                        "maxLength": 22,
                        "pattern": "^\\d{22}$",
                        "title": "Account Number",
                        "description": "22-digit account number.",
                        "errorMessage": {
                            "minLength": "Must be 22 digits",
                            "maxLength": "Must be 22 digits",
                            "pattern": "Must be a 22-digit number"
                        }
                    },
                    "beneficiaryType": {
                        "type": "string",
                        "enum": [
                            "individual",
                            "business"
                        ],
                        "title": "Beneficiary Type",
                        "description": "Type of beneficiary.",
                        "errorMessage": {
                            "enum": "Must be either 'individual' or 'business'"
                        }
                    },
                    "phone": {
                        "type": "string",
                        "minLength": 10,
                        "maxLength": 11,
                        "pattern": "^\\d{10,11}$",
                        "title": "Phone Number",
                        "description": "10-11 digit phone number.",
                        "errorMessage": {
                            "minLength": "Must be at least 10 digits",
                            "maxLength": "Must be at most 11 digits",
                            "pattern": "Must be a 10-11 digit number"
                        }
                    },
                    "phoneCode": {
                        "type": "string",
                        "const": "+54",
                        "title": "Phone Code",
                        "description": "Country code for Argentina (+54)",
                        "errorMessage": {
                            "const": "Phone code must be '+54'"
                        }
                    },
                    "payerName": {
                        "type": "string",
                        "minLength": 1,
                        "title": "Payer Name",
                        "description": "Name of the payer.",
                        "errorMessage": {
                            "minLength": "Payer name is required"
                        }
                    },
                    "street": {
                        "type": "string",
                        "minLength": 1,
                        "title": "Street",
                        "description": "Street address.",
                        "errorMessage": {
                            "minLength": "Street is required"
                        }
                    },
                    "city": {
                        "type": "string",
                        "minLength": 1,
                        "title": "City",
                        "description": "City name.",
                        "errorMessage": {
                            "minLength": "City is required"
                        }
                    },
                    "state": {
                        "type": "string",
                        "minLength": 1,
                        "title": "State",
                        "description": "State name.",
                        "errorMessage": {
                            "minLength": "State is required"
                        }
                    },
                    "dob": {
                        "type": "string",
                        "pattern": "^\\d{2}-\\d{2}-\\d{4}$",
                        "title": "Date of Birth",
                        "description": "Date of birth in DD-MM-YYYY format.",
                        "errorMessage": {
                            "pattern": "Date of birth must be in DD-MM-YYYY format"
                        }
                    },
                    "postalCode": {
                        "type": "string",
                        "minLength": 1,
                        "title": "Postal Code",
                        "description": "Postal code.",
                        "errorMessage": {
                            "minLength": "Postal code is required"
                        }
                    },
                    "bankCode": {
                        "type": "string",
                        "enum": [
                            "wilobank",
                            "banco_bbva_argentina",
                            "banco_santander"
                        ],
                        "title": "Bank",
                        "description": "Bank for the account.",
                        "errorMessage": {
                            "enum": "Must be a valid ARS bank code"
                        }
                    }
                },
                "additionalProperties": false
            },
            "uiSchema": {
                "documentType": {
                    "ui:widget": "select",
                    "ui:options": {
                        "enumNames": [
                            "DNI",
                            "CUIT"
                        ]
                    },
                    "ui:placeholder": "Select document type"
                },
                "documentNumber": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. 12345678A"
                },
                "accountType": {
                    "ui:widget": "select",
                    "ui:options": {
                        "enumNames": [
                            "Checking",
                            "Savings"
                        ]
                    },
                    "ui:placeholder": "Select account type"
                },
                "accountNumber": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. 1234567890123456789012"
                },
                "beneficiaryType": {
                    "ui:widget": "select",
                    "ui:options": {
                        "enumNames": [
                            "Individual",
                            "Business"
                        ]
                    },
                    "ui:placeholder": "Select beneficiary type"
                },
                "phone": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. 1123456789"
                },
                "phoneCode": {
                    "ui:widget": "hidden"
                },
                "payerName": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. Juan Perez"
                },
                "street": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. Calle Falsa 123"
                },
                "city": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. Buenos Aires"
                },
                "state": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. Buenos Aires"
                },
                "dob": {
                    "ui:widget": "text",
                    "ui:placeholder": "DD-MM-YYYY"
                },
                "postalCode": {
                    "ui:widget": "text",
                    "ui:placeholder": "e.g. C1000AAQ"
                },
                "bankCode": {
                    "ui:widget": "select",
                    "ui:options": {
                        "enumNames": [
                            "Wilobank",
                            "Banco BBVA Argentina",
                            "Banco Santander"
                        ]
                    },
                    "ui:placeholder": "Select bank"
                },
                "ui:order": [
                    "documentType",
                    "documentNumber",
                    "accountType",
                    "accountNumber",
                    "beneficiaryType",
                    "phone",
                    "phoneCode",
                    "payerName",
                    "street",
                    "city",
                    "state",
                    "dob",
                    "postalCode",
                    "bankCode"
                ]
            }
        }
    }
}
Modified at 2025-11-11 17:23:07
Previous
Update Plaid Link Token
Next
Add External Account
Built with