Cdtr

The Cdtr object contains information about the creditor (also known as the beneficiary) such as their name, contact information, and address. This information is provided using objects nested within the Cdtr object. See the table below, or download the Cdtr schema.

Note

When you're creating an identity, the Cdtr object fields you need to include may vary based on the data required for a specific beneficiary country and currency. For more information, see Get data requirements.

required

object

Party to which an amount of money is due.

string [ 1 .. 140 ] characters ^[a-zA-Z0-9 \t]+$

Allows the name of the Creditor to be held as a single value.

Required if the creditor is an organization.
Not applicable if the creditor is an individual, specify StrdNm instead.

Requirements

Must include one (1) name string.
Allowable characters: Alphanumeric and space.
Names with multiple words must be separated by a space.
For example, specify "Widgets Org", as Widgets Org.
Provide a truncated name if longer than 140 characters.

object

Allows the name of the Creditor to be held in a structured format.

Required if the creditor is an individual.
Not applicable if the creditor is an organization, use Nm instead.

FirstNm required	string [ 1 .. 30 ] characters ^[a-zA-Z0-9 \t]+$ First name by which the party is known and which is usually used to identify the party. Requirements Must include one (1) name string. If the first name has two or more words, separate them with a space. Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead. Provide a truncated name if longer than allowable characters. Example If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.
MidNm	string [ 1 .. 30 ] characters ^[a-zA-Z0-9 \t]+$ Middle name by which the party is known and which is usually used to identify the party.
LastNm required	string [ 1 .. 30 ] characters ^[a-zA-Z0-9 \t]+$ Last name by which the party is known and which is usually used to identify the party. Requirements Must include one (1) name string. If the last name has two or more words, separate them with a space. Provide a truncated name if longer than allowable characters. Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead. Example If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.
LastNm2	string [ 1 .. 30 ] characters ^[a-zA-Z0-9 \t]+$ Secondary last name by which the party is known and which is usually used to identify the party.
NtrlNm	string [ 1 .. 140 ] characters Name in local character set or language.
Title	string [ 1 .. 20 ] characters Title by which the party is known and which is usually used to identify the party.

CtryOfRes

string^[A-Z]{2}$

Allows the Country of Residence of the Creditor to be held. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

object

Allows the address of the Creditor to be held.

AdrLine	Array of arrays <= 70 characters Information that locates and identifies the address for the party.
PstCd	string <= 16 characters Information that locates and identifies postal code for the party, as defined by postal services.
TwnNm	string <= 35 characters Information that locates and identifies the city / town for the party, as defined by postal services.

object

Allows the contact of the Creditor to be held.

MobNb	string <= 15 characters ^\+?[1-9]\d{1,14}$ Mobile Phone Number
EmailAdr	string <email> <= 2048 characters Address for electronic mail (e-mail).

object

Unique and unambiguous way to identify the Creditor.

	object Unique and unambiguous way to identify a business or institutional beneficiary. If the beneficiary is an individual, specify `PrvtId` instead.
	object Unique and unambiguous way to identify an individual beneficiary, for example, using their passport. If the beneficiary is a business or institution, specify `OrgId` instead.