Payout payload
Sender and UBOs
The sender object identifies the business performing the payout and the
natural persons who ultimately own or control it.
Sender fields
| Field | Type or format | Requiredness | Description |
|---|---|---|---|
sender.name | String | Required | Registered legal business name. |
sender.countryOfIncorporation | ISO 3166-1 alpha-2 | Required | Country where the business is incorporated. |
sender.address.addressLine | String | Required | Registered street address. |
sender.address.city | String | Required | Registered city or town. |
sender.address.postalCode | String | Recommended | Registered postal or ZIP code. |
sender.address.region | String | Recommended | State, province, or region. |
sender.address.country | ISO 3166-1 alpha-2 | Required | Country of the registered address. |
sender.contact.email | Required | Business contact email. | |
sender.contact.phoneNumber | International phone number | Required | Business contact phone number. |
sender.id.type | String | Required | Type of business registration or identification. Supply an accepted Axiym value or descriptive text. |
sender.id.number | String | Required | Business registration or identification number. |
sender.id.country | ISO 3166-1 alpha-2 | Recommended | Country that issued the identifier. |
sender.id.issueDate | ISO 8601 date | Recommended | Date the identifier was issued. |
sender.id.expiryDate | ISO 8601 date | Recommended | Expiry date, when the identifier expires. |
sender.ubos[] | Array | Required | One or more natural persons who ultimately own or control the sender. |
UBO fields
Provide one entry in sender.ubos[] for each natural person who ultimately
owns or controls the business.
| Field | Type or format | Requiredness | Description |
|---|---|---|---|
sender.ubos[].firstName | String | Required | UBO's given name. |
sender.ubos[].lastName | String | Required | UBO's family name. |
sender.ubos[].designation | Controlled value | Required | Relationship to the sender. Every entry represents a UBO; Axiym uses the final value ubo. |
sender.ubos[].nationalities[] | ISO 3166-1 alpha-2[] | Required | One or more nationalities. |
sender.ubos[].address.addressLine | String | Required | Residential address line. |
sender.ubos[].address.city | String | Required | Residential city or town. |
sender.ubos[].address.postalCode | String | Recommended | Residential postal or ZIP code. |
sender.ubos[].address.region | String | Recommended | Residential state, province, or region. |
sender.ubos[].address.country | ISO 3166-1 alpha-2 | Required | Country of residence. |
sender.ubos[].id.type | String | Required | Type of personal identification. Supply an accepted Axiym value or descriptive text. |
sender.ubos[].id.number | String | Required | Identification document number. |
sender.ubos[].id.country | ISO 3166-1 alpha-2 | Recommended | Issuing country. |
sender.ubos[].id.issueDate | ISO 8601 date | Recommended | Issue date. |
sender.ubos[].id.expiryDate | ISO 8601 date | Recommended | Expiry date. |
UBO data describes ownership or control. It does not mean the owner personally owes the payment being made by the sender.
Identification types are normalized to Axiym's controlled values before validation. This applies whether the sender uses Axiym's field structure or is translated through a Party Data Map. Names, addresses, identifier numbers, and other factual values are validated but are not classified as enum values.
Example
{
"name": "Acme Trading Pte Ltd",
"countryOfIncorporation": "SG",
"address": {
"addressLine": "18 Robinson Road",
"city": "Singapore",
"postalCode": "048547",
"region": "Singapore",
"country": "SG"
},
"contact": {
"email": "payments@acme.example",
"phoneNumber": "+6561234567"
},
"id": {
"type": "company registration number",
"number": "202412345A",
"country": "SG",
"issueDate": "2024-03-15"
},
"ubos": [
{
"firstName": "Maya",
"lastName": "Tan",
"designation": "ultimate beneficial owner",
"nationalities": ["SG"],
"address": {
"addressLine": "10 Anson Road",
"city": "Singapore",
"postalCode": "079903",
"country": "SG"
},
"id": {
"type": "passport",
"number": "E1234567A",
"country": "SG",
"issueDate": "2023-01-10",
"expiryDate": "2033-01-09"
}
}
]
}