API Reference

Return a list of KYC fields that alfred collects and passes to the liquidity partner to proceed with their KYC verification process.

Considerations: Take into account which fields require a certain ISO format - ISO2 & ISO3, and which fields do not require an ISO format.

Field descriptions:

"firstName”: First Name of User

"lastName”: Last Name of User

"dateOfBirth”: Birthday of User

"country”: Country user resides

"countryCode”: Country Code of where user resides - ISO2 (Example: MX | Mexico)

"city”: City where user resides

"zipCode”: User’s Zip code

"address”: User’s address

"National ID”: User’s Type of National ID being submitted

  • type: string
  • required: true, false
  • description: Alpha Country Code
    Example value: USA, ARG, MEX, BRA, GBR

Response:

{
    "kycRequiredFields": [
        {
            "fieldName": "firstName",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "lastName",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "dateOfBirth",
            "required": true,
            "type": "DATE"
        },
        {
            "fieldName": "country",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "countryCode",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "state",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "stateCode",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "city",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "zipCode",
            "required": true,
            "type": "NUMBER"
        },
        {
            "fieldName": "address",
            "required": true,
            "type": "STRING"
        },
        {
            "fieldName": "National ID",
            "required": true,
            "type": "FILE_UPLOAD"
        },        
        {
            "fieldName": "Selfie",
            "required": true,
            "type": "FILE_UPLOAD"
        }
    ]
}

Language
Click Try It! to start a request and see the response here!