ISO20022object§ 4.1.8 · PDF p. 15

PartyIdentification

API : Description of a Party which can be either a person or an organization.

Fields (7)

  • namestringrequired

    ISO20022: Name by which a party is known and which is usually used to identify that party.

    ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.

    Constraints: maxLength: 140

  • dateAndPlaceOfBirthDateAndPlaceOfBirth

    Date and place of birth of a person.

    Schema: DateAndPlaceOfBirth

    Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

    • birthDatestring (date)ISO 8601required

      Date on which a person is born.

    • cityOfBirthstringrequired

      City where a person was born.

      Constraints: maxLength: 35

    • countryOfBirthstringrequired

      Country where a person was born.

      Constraints: pattern: `^[A-Z]{2,2}$`

  • postalAddressPostalAddress

    ISO20022: Information that locates and identifies a specific address, as defined by postal services.

    Schema: PostalAddress

    ISO20022: Information that locates and identifies a specific address, as defined by postal services.

    • addressTypestringenum · 6

      ISO20022: Identifies the nature of the postal address.

      ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

      CodeNameDescription
      BIZZ
      BusinessAddress is the business address
      DLVY
      DeliveryAddress is the address to which delivery is to take place
      MLTO
      Mail ToAddress is the address to which mail is sent
      PBOX
      PO BoxAddress is is a postal office (PO) box
      ADDR
      PostalAddress is the complete postal address
      HOME
      HomeAddress is the home address
    • departmentstring

      ISO20022: Identification of a division of a large organisation or building.

      ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 70

    • subDepartmentstring

      ISO20022: Identification of a sub-division of a large organisation or building.

      ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 70

    • streetNamestring

      ISO20022: Name of a street or thoroughfare.

      ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 70

    • buildingNumberstring

      ISO20022: Number that identifies the position of a building on a street.

      ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 16

    • buildingNamestring

      ISO20022: Name of the building or house.

      ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 16

    • postCodestring

      ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

      ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 16

    • townNamestring

      ISO20022: Name of a built-up area, with defined boundaries, and a local government.

      ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 35

    • countrySubDivisionstring

      ISO20022: Identifies a subdivision of a country such as state, region, county.

      ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

      Constraints: maxLength: 35

    • countrystringrequired

      ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.

      ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.

      Constraints: pattern: `^([A-Z]{2,2})$`

    • addressLinearray<string>

      Unstructured address. The lines must embed zip code and town name.

      Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

      Type: array<string>

      Item: Address line

      Item constraints: maxLength: 70

  • contactDetailsContactDetails

    Indicates how to contact the party.

    Schema: ContactDetails

    Indicates how to contact the party.

    • phoneNumberPhoneNumber

      The collection of information which identifies a specific phone or FAX number as defined by telecom services.

      Schema: PhoneNumber

      The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

      Type: string

      Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

    • faxNumberPhoneNumber

      The collection of information which identifies a specific phone or FAX number as defined by telecom services.

      Schema: PhoneNumber

      The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

      Type: string

      Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

    • emailAddressstring

      email address of the contact

      Constraints: maxLength: 2048 · pattern: `^.+@.+$`

  • organisationIdGenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.

    Schema: GenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

      Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

      CodeNameDescription
      BANKBankPartyIdentificationUnique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
      BBANBBANIdentifierBasic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
      COIDCountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
      SRENSIRENThe SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
      SRETSIRETThe SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
      NIDNNationalIdentityNumberNumber assigned by an authority to identify the national identity number of a person.
      Other values are also permitted, for instance:
      CodeNameDescription
      -------------------
      OAUTOAUTH2OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
      CPANCardPanCard PAN
      MPANMaskedPanCard PAN where some digits were replaced for security reason
      TPANTokenizedPanToken which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
      TBANTokenizedIBANToken which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
      Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      Constraints: maxLength: 35

  • privateIdGenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.

    Schema: GenericIdentification

    ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

    • identificationstringrequired

      API: Identifier

      API: Identifier

      Constraints: maxLength: 70

    • schemeNamestringrequired

      Name of the identification scheme.

      Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

      CodeNameDescription
      BANKBankPartyIdentificationUnique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
      BBANBBANIdentifierBasic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
      COIDCountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
      SRENSIRENThe SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
      SRETSIRETThe SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
      NIDNNationalIdentityNumberNumber assigned by an authority to identify the national identity number of a person.
      Other values are also permitted, for instance:
      CodeNameDescription
      -------------------
      OAUTOAUTH2OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
      CPANCardPanCard PAN
      MPANMaskedPanCard PAN where some digits were replaced for security reason
      TPANTokenizedPanToken which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
      TBANTokenizedIBANToken which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
      Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

      Constraints: maxLength: 70

    • issuerstring

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

      Constraints: maxLength: 35

  • leiLeiIdentification

    Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

    Schema: LeiIdentification

    Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

    Type: string

    Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`