# 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.

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](/products/payments-direct/api-docs/tutorials/create-an-identity#get-data-requirements).

The beneficiary you are paying may be an individual or a business. See the following sections for the `Cdtr` object schemas for each beneficiary type.

## Business beneficiary schema

See the table below, or download the [business beneficiary Cdtr schema](/assets/cdtr-business.1ed71067a86ce4b713df30fe7563b4376aa02ace9fa7cec3b45cec0cac0c145a.3ea817e8.json).

details
summary
Expand to see the Cdtr object schema for a business beneficiary.

```json
{
  "$ref": "#/components/schemas/cdtr-business",
  "components": {
    "schemas": {
      "cdtr-business": {
        "schema": "http://json-schema.org/draft-06/schema#",
        "id": "file://po11#",
        "description": "Cdtr object schema",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Cdtr": {
            "type": "object",
            "description": "Party to which an amount of money is due.",
            "properties": {
              "Nm": {
                "type": "string",
                "description": "Allows the name of the Creditor to be held as a single value.\n\n• Required if the creditor is an organization.\n\nRequirements:\n\n• Must include one (1) name string.\n\n• Allowable characters: Alphanumeric and space.\n\n• Names with multiple words must be separated by a space. For example, specify \"Widgets Org\", as `Widgets Org`.\n\n• Provide a truncated name if longer than 140 characters.",
                "pattern": "^[a-zA-Z0-9 \\t]+$",
                "minLength": 1,
                "maxLength": 140
              },
              "CtryOfRes": {
                "type": "string",
                "description": "Allows the Country of Residence of the Creditor to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
                "pattern": "^[A-Z]{2}$"
              },
              "PstlAdr": {
                "type": "object",
                "description": "Allows the address of the Creditor to be held.",
                "properties": {
                  "AdrLine": {
                    "description": "Information that locates and identifies the address for the party.",
                    "type": "array",
                    "maxLength": 70
                  },
                  "PstCd": {
                    "description": "Information that locates and identifies postal code for the party, as defined by postal services.",
                    "type": "string",
                    "maxLength": 16
                  },
                  "TwnNm": {
                    "description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
                    "type": "string",
                    "maxLength": 35
                  },
                  "CtrySubDvsn": {
                    "description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
                    "type": "string",
                    "maxLength": 35
                  },
                  "Ctry": {
                    "type": "string",
                    "pattern": "^[A-Z]{2}$",
                    "description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
                  }
                }
              },
              "CtctDtls": {
                "type": "object",
                "description": "Allows the contact of the Creditor to be held.",
                "properties": {
                  "MobNb": {
                    "type": "string",
                    "description": "Mobile Phone Number",
                    "maxLength": 15,
                    "pattern": "^\\+?[1-9]\\d{1,14}$"
                  },
                  "EmailAdr": {
                    "type": "string",
                    "description": "Address for electronic mail (e-mail).",
                    "format": "email",
                    "maxLength": 2048
                  }
                }
              },
              "Id": {
                "type": "object",
                "description": "Unique and unambiguous way to identify the Creditor.",
                "properties": {
                  "OrgId": {
                    "type": "object",
                    "description": "Unique and unambiguous way to identify a business or institutional beneficiary.",
                    "properties": {
                      "Othr": {
                        "type": "array",
                        "description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
                        "items": {
                          "type": "object",
                          "properties": {
                            "Id": {
                              "description": "Identification assigned by an institution.",
                              "type": "string",
                              "maxLength": 35
                            },
                            "SchmeNm": {
                              "type": "object",
                              "description": "Name of the organization identification scheme.",
                              "properties": {
                                "Cd": {
                                  "type": "string",
                                  "description": "List based on ExternalorganizationIdentification1Code List",
                                  "enum": [
                                    "BANK",
                                    "CBID",
                                    "CHID",
                                    "CINC",
                                    "COID",
                                    "CUST",
                                    "DUNS",
                                    "EMPL",
                                    "GS1G",
                                    "SREN",
                                    "SRET",
                                    "TXID",
                                    "USCC"
                                  ],
                                  "x-enumDescriptions": {
                                    "BANK": "Bank Party Identification",
                                    "CBID": "Central Bank Identification Number",
                                    "CHID": "Clearing Identification Number",
                                    "CINC": "Certificate Of Incorporation Number",
                                    "COID": "Country Identification Code",
                                    "CUST": "Customer Number",
                                    "DUNS": "Data Universal Numbering System",
                                    "EMPL": "Employer Identification Number",
                                    "GS1G": "GS1GLN Identifier",
                                    "SREN": "SIREN",
                                    "SRET": "SIRET",
                                    "TXID": "Tax Identification Number",
                                    "USCC": "Unified Social Credit Code"
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "RelShipToDbtr": {
                        "type": "string",
                        "description": "Indicates the relationship between the Originator and Beneficiary.",
                        "enum": [
                          "BRAN",
                          "CUST",
                          "FRAN",
                          "HOLD",
                          "PART",
                          "SUBS",
                          "SUPP"
                        ],
                        "x-enumDescriptions": {
                          "BRAN": "Branch or representative office",
                          "CUST": "Customer",
                          "FRAN": "Franchisee or franchisor",
                          "HOLD": "Holding company",
                          "PART": "Business partner",
                          "SUBS": "Subsidiary company",
                          "SUPP": "Supplier"
                        }
                      },
                      "DtAndPlcofIncorprtn": {
                        "type": "object",
                        "description": "Indicates the organization's date and place of incorporation.",
                        "properties": {
                          "DtofIncorprtn": {
                            "type": "string",
                            "description": "The date of incorporation for the organization.",
                            "format": "date",
                            "pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
                          },
                          "CtryofIncorprtn": {
                            "type": "string",
                            "description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
                            "pattern": "^[A-Z]{2}"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "required": [
          "Cdtr"
        ]
      }
    }
  }
}
```

## Individual beneficiary schema

See the table below, or download the [individual beneficiary Cdtr schema](/assets/cdtr-individual.ac93b83b5cc45e9584dfd4c3f5e53ebafb2ae4c22a1b6dfc12c13da8cc19d69b.3ea817e8.json).

details
summary
Expand to see the Cdtr object schema for an individual beneficiary.

```json
{
  "$ref": "#/components/schemas/cdtr-individual",
  "components": {
    "schemas": {
      "cdtr-individual": {
        "schema": "http://json-schema.org/draft-06/schema#",
        "id": "file://po11#",
        "description": "Cdtr object schema",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Cdtr": {
            "type": "object",
            "description": "Party to which an amount of money is due.",
            "properties": {
              "StrdNm": {
                "type": "object",
                "description": "Allows the name of the Creditor to be held in a structured format.\n\n• Required if the creditor is an individual.",
                "required": [
                  "FirstNm",
                  "LastNm"
                ],
                "properties": {
                  "FirstNm": {
                    "description": "First name by which the party is known and which is usually used to identify the party.\n\nRequirements:\n\n• Must include one (1) name string.\n\n• If the first name has two or more words, separate them with a space.\n\n• Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.\n\n• Provide a truncated name if longer than allowable characters.\n\nExample: 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'.",
                    "type": "string",
                    "pattern": "^[a-zA-Z0-9 \\t]+$",
                    "minLength": 1,
                    "maxLength": 30
                  },
                  "MidNm": {
                    "description": "Middle name by which the party is known and which is usually used to identify the party.",
                    "type": "string",
                    "pattern": "^[a-zA-Z0-9 \\t]+$",
                    "minLength": 1,
                    "maxLength": 30
                  },
                  "LastNm": {
                    "description": "Last name by which the party is known and which is usually used to identify the party.\n\nRequirements\n\n• Must include one (1) name string.\n\n• If the last name has two or more words, separate them with a space.\n\n• Provide a truncated name if longer than allowable characters.\n\n• 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'.",
                    "type": "string",
                    "pattern": "^[a-zA-Z0-9 \\t]+$",
                    "minLength": 1,
                    "maxLength": 30
                  },
                  "LastNm2": {
                    "description": "Secondary last name by which the party is known and which is usually used to identify the party.",
                    "type": "string",
                    "pattern": "^[a-zA-Z0-9 \\t]+$",
                    "minLength": 1,
                    "maxLength": 30
                  },
                  "NtrlNm": {
                    "description": "Name in local character set or language.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 140
                  },
                  "Title": {
                    "description": "Title by which the party is known and which is usually used to identify the party.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                  }
                }
              },
              "CtryOfRes": {
                "deprecated": true,
                "type": "string",
                "description": "NOTE: This field is deprecated. Use the `Id.PrvtId.Ntlty` field instead to specify the beneficiary's nationality. \n\nAllows the Country of Residence of the Creditor to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
                "pattern": "^[A-Z]{2}$"
              },
              "PstlAdr": {
                "type": "object",
                "description": "Allows the address of the Creditor to be held.",
                "properties": {
                  "AdrLine": {
                    "description": "Information that locates and identifies the address for the party.",
                    "type": "array",
                    "maxLength": 70
                  },
                  "PstCd": {
                    "description": "Information that locates and identifies postal code for the party, as defined by postal services.",
                    "type": "string",
                    "maxLength": 16
                  },
                  "TwnNm": {
                    "description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
                    "type": "string",
                    "maxLength": 35
                  }
                }
              },
              "CtctDtls": {
                "type": "object",
                "description": "Allows the contact of the Creditor to be held.",
                "properties": {
                  "MobNb": {
                    "type": "string",
                    "description": "Mobile Phone Number",
                    "maxLength": 15,
                    "pattern": "^\\+?[1-9]\\d{1,14}$"
                  },
                  "EmailAdr": {
                    "type": "string",
                    "description": "Address for electronic mail (e-mail).",
                    "format": "email",
                    "maxLength": 2048
                  }
                }
              },
              "Id": {
                "type": "object",
                "description": "Unique and unambiguous way to identify the Creditor.",
                "properties": {
                  "PrvtId": {
                    "type": "object",
                    "description": "Unique and unambiguous way to identify an individual beneficiary, for example, using their passport.",
                    "properties": {
                      "DtAndPlcOfBirth": {
                        "type": "object",
                        "description": "Date and place of birth of a person.",
                        "properties": {
                          "BirthDt": {
                            "description": "Information that identifies the date of Birth for the party.",
                            "type": "string",
                            "format": "date",
                            "pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
                          }
                        }
                      },
                      "Othr": {
                        "type": "array",
                        "description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
                        "items": {
                          "type": "object",
                          "properties": {
                            "Id": {
                              "description": "Value to be used to identify the party",
                              "type": "string",
                              "maxLength": 35
                            },
                            "Issr": {
                              "description": "Information for the entity that assigns the identification.",
                              "type": "string",
                              "maxLength": 35
                            },
                            "SchmeNm": {
                              "type": "object",
                              "description": "Name of the identification scheme used to identify an individual.",
                              "properties": {
                                "Cd": {
                                  "type": "string",
                                  "description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
                                  "enum": [
                                    "ARNU",
                                    "CCPT",
                                    "CUST",
                                    "DRLC",
                                    "EMPL",
                                    "NIDN",
                                    "SOS",
                                    "TELE",
                                    "TXID"
                                  ],
                                  "x-enumDescriptions": {
                                    "ARNU": "Alien Registration Number",
                                    "CCPT": "Passport Number",
                                    "CUST": "Customer Identification Number",
                                    "DRLC": "Drivers License Number",
                                    "EMPL": "Employee Identification Number",
                                    "NIDN": "National Identity Number",
                                    "SOS": "Social Security Number",
                                    "TELE": "Telephone Number",
                                    "TXID": "Tax Identification Number"
                                  }
                                },
                                "Prtry": {
                                  "type": "string",
                                  "description": "Field to support proprietary value",
                                  "maxLength": 35
                                }
                              }
                            },
                            "DtOfIss": {
                              "type": "string",
                              "description": "Issue date of the supporting documentation.",
                              "format": "date",
                              "pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
                            },
                            "DtOfXpry": {
                              "type": "string",
                              "description": "Expiration date of the supporting documentation.",
                              "format": "date",
                              "pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
                            },
                            "MrzNb": {
                              "description": "Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
                              "type": "string",
                              "maxLength": 88,
                              "pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
                            }
                          }
                        }
                      },
                      "RelShipToDbtr": {
                        "description": "Relationship of the receiving party to the sending party.",
                        "type": "string",
                        "enum": [
                          "CHIL",
                          "CUST",
                          "EMPL",
                          "EXSP",
                          "FREN",
                          "OTHR",
                          "PARE",
                          "PART",
                          "RELA",
                          "SELF",
                          "SIBL",
                          "SPOU",
                          "VEND"
                        ],
                        "x-enumDescriptions": {
                          "CHIL": "Child",
                          "CUST": "Customer",
                          "EMPL": "Employee",
                          "EXSP": "Ex-spouse",
                          "FREN": "Friend",
                          "OTHR": "Other",
                          "PARE": "Parent",
                          "PART": "Business partner",
                          "RELA": "Relation",
                          "SELF": "Self",
                          "SIBL": "Sibling",
                          "SPOU": "Covering Spouse/Partner",
                          "VEND": "Vendor"
                        }
                      },
                      "Ntlty": {
                        "type": "string",
                        "pattern": "^[A-Z]{2}$",
                        "description": "Alpha-2 country code for the nationality of the party in [ISO 3166-1](https://www.iso.org/obp/ui/#search) format.",
                        "maxLength": 3
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "required": [
          "Cdtr"
        ]
      }
    }
  }
}
```