Recipient schema
Sample Request
curl --request GET \
--url {api_endpoint}/organizations/{tenant}/payout/recipients/schema/{destinationCountryIso2} \
--header 'content-type: application/json' \
--header 'x-agent-api-key: {agentApiKey}' \
--header 'x-agent-id: {agentId}'{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Inyo Global Recipient Data - Colombia",
"description": "Schema for a COL person.",
"version": "1.0.0",
"type": "object",
"required": [
"firstName",
"lastName",
"address",
"documents"
],
"properties": {
"firstName": {
"type": "string",
"description": "The first name of the person.",
"minLength": 1
},
"lastName": {
"type": "string",
"description": "The last name of the person.",
"minLength": 1
},
"birthDate": {
"type": "string",
"description": "The birth date of the person. Formatted as yyyy-MM-dd",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"phoneNumber": {
"type": "string",
"description": "The contact phone number of the person.",
"minLength": 1
},
"documents": {
"type": "array",
"description": "A list of identification documents for the person.",
"minItems": 1,
"items": {
"type": "object",
"required": [
"document",
"type"
],
"properties": {
"document": {
"type": "string",
"description": "The document number."
},
"type": {
"type": "string",
"description": "The type of document.",
"enum": [
"CC"
]
},
"countryCode": {
"type": "string",
"description": "The country code of document.",
"enum": [
"CO"
]
}
},
"if": {
"properties": {
"type": {
"const": "CC"
}
}
},
"then": {
"properties": {
"document": {
"description": "Cédula de Ciudadania",
"pattern": "^(\\d){8,10}"
}
}
}
}
}
}
}GET /organizations/{tenant}/payout/recipients/schema/{destinationCountryIso2}Last updated