Adyen · Schema

IdentificationData

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
cardNumber	string	The card number of the document that was issued (AU only).
expiryDate	string	The expiry date of the document, in YYYY-MM-DD format.
issuerCountry	string	The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, US.
issuerState	string	The state or province where the document was issued (AU only).
nationalIdExempt	boolean	Applies only to individuals in the US. Set to true if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.
number	string	The number in the document.
type	string	Type of identity data. For individual, the `type` value is nationalIdNumber.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IdentificationData",
  "title": "IdentificationData",
  "properties": {
    "cardNumber": {
      "description": "The card number of the document that was issued (AU only).",
      "type": "string"
    },
    "expiryDate": {
      "description": "The expiry date of the document, in YYYY-MM-DD format.",
      "type": "string"
    },
    "issuerCountry": {
      "deprecated": true,
      "x-deprecatedInVersion": "1",
      "description": "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.",
      "type": "string"
    },
    "issuerState": {
      "description": "The state or province where the document was issued (AU only).",
      "type": "string"
    },
    "nationalIdExempt": {
      "description": "Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.",
      "type": "boolean"
    },
    "number": {
      "description": "The number in the document.",
      "type": "string"
    },
    "type": {
      "description": "Type of identity data. For **individual**, the `type` value is **nationalIdNumber**.",
      "enum": [
        "nationalIdNumber"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}