Sender and related individuals

The sender object identifies the business making the payment: your organization or a client you are paying for. It contains the business's identity, address, contact, and registration details, with related individuals in relationships and the documents that evidence them.

Omit sender when you pay for yourself. The account holder is then the sender and its onboarded profile is used; the fields below apply when you pay on behalf of a client.

Addresses are structured following ISO 20022. streetName is the primary address line, not literally a street name: it can carry the full street address and number, a PO box, or a building or lot description. Use the value that identifies the location; do not use placeholder values.

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.streetName`	String	Required	Primary address line: street and number, PO box, or building or lot description.
`sender.address.buildingNumber`	String	Optional	Building number, when held separately.
`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`	Email	Required	Business contact email.
`sender.contact.phoneNumber`	International phone number	Required	Business contact phone number.
`sender.identification.type`	String	Required	Type of business registration or identification. Use an exact Axiym code; other labels need a saved value translation on the mapped endpoint.
`sender.identification.number`	String	Required	Business registration or identification number.
`sender.identification.country`	ISO 3166-1 alpha-2	Recommended	Country that issued the identifier.
`sender.identification.issueDate`	ISO 8601 date	Recommended	Date the identifier was issued.
`sender.identification.expiryDate`	ISO 8601 date	Recommended	Expiry date, when the identifier expires.
`sender.identification.documents[]`	SupportingDocumentInput[]	Conditional	Documents evidencing the registration, such as a registry extract. Required where the corridor requires identity evidence.
`sender.documents[]`	SupportingDocumentInput[]	Conditional	Documents about the business that do not evidence a specific identification, such as a proof of address.
`sender.relationships[]`	Array	Required	One or more natural persons related to the sender, each with a role.

Relationship fields

Use sender.relationships[] for the related individuals required for the payment, with one entry per person and their role. Each entry represents a natural person, not a company in an ownership chain. Apply the baseline and corridor requirements when deciding which individuals to include.

Field	Type or format	Requiredness	Description
`sender.relationships[].firstName`	String	Required	Given name.
`sender.relationships[].lastName`	String	Required	Family name.
`sender.relationships[].role`	Axiym enum	Required	Individual's role. Use an exact Axiym code; other labels need a saved value translation on the mapped endpoint. See Controlled values.
`sender.relationships[].nationalities[]`	ISO 3166-1 alpha-2[]	Required	One or more nationalities.
`sender.relationships[].address.streetName`	String	Required	Primary residential-address line: street and number, PO box, or building or lot description.
`sender.relationships[].address.buildingNumber`	String	Optional	Building number, when held separately.
`sender.relationships[].address.city`	String	Required	Residential city or town.
`sender.relationships[].address.postalCode`	String	Recommended	Residential postal or ZIP code.
`sender.relationships[].address.region`	String	Recommended	Residential state, province, or region.
`sender.relationships[].address.country`	ISO 3166-1 alpha-2	Required	Country of residence.
`sender.relationships[].identification.type`	String	Required	Type of personal identification. Use an exact Axiym code; other labels need a saved value translation on the mapped endpoint.
`sender.relationships[].identification.number`	String	Required	Identification document number.
`sender.relationships[].identification.country`	ISO 3166-1 alpha-2	Recommended	Issuing country.
`sender.relationships[].identification.issueDate`	ISO 8601 date	Recommended	Issue date.
`sender.relationships[].identification.expiryDate`	ISO 8601 date	Recommended	Expiry date.
`sender.relationships[].identification.documents[]`	SupportingDocumentInput[]	Conditional	Documents evidencing the individual's identification, such as a passport scan, where the corridor requires them.

Direct requests require exact identification type and relationship role codes. The mapped endpoint also accepts labels covered by saved value translations. Names, addresses, identifier numbers, and other factual values are validated but are not classified as controlled values.

Example

{
  "name": "Acme Trading Pte Ltd",
  "countryOfIncorporation": "SG",
  "address": {
    "streetName": "Robinson Road",
    "buildingNumber": "18",
    "city": "Singapore",
    "postalCode": "048547",
    "region": "Singapore",
    "country": "SG"
  },
  "contact": {
    "email": "payments@acme.example",
    "phoneNumber": "+6561234567"
  },
  "identification": {
    "type": "REGISTRATION_NUMBER",
    "number": "202412345A",
    "country": "SG",
    "issueDate": "2024-03-15",
    "documents": [
      {
        "documentType": "REGISTRY_EXTRACT",
        "name": "acme-registry-extract.pdf",
        "data": "REPLACE_WITH_BASE64_ENCODED_REGISTRY_EXTRACT"
      }
    ]
  },
  "relationships": [
    {
      "role": "UBO",
      "firstName": "Maya",
      "lastName": "Tan",
      "nationalities": ["SG"],
      "address": {
        "streetName": "Anson Road",
        "buildingNumber": "10",
        "city": "Singapore",
        "postalCode": "079903",
        "country": "SG"
      },
      "identification": {
        "type": "PASSPORT",
        "number": "E7654321B",
        "country": "SG",
        "issueDate": "2023-01-10",
        "expiryDate": "2033-01-09"
      }
    }
  ]
}

Sender fields

Relationship fields

Example

On this page