Consumer API

Get Consumer Information

get

This request is used by the D1 backend to request the details of an end user (consumer) from the issuer backend.

If the end user information is associated with the card, it is possible to activate "cardId" query parameter via an onboarding flag.

Authorizations

bearerAuth

AuthorizationstringRequired

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Path parameters

issuerIdstring · min: 10 · max: 10Required

The id of the issuer

consumerIdstring · min: 1 · max: 64Required

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Query parameters

cardIdstring · min: 1 · max: 48Optional

Unique identifier of the card.

Example: cardId=crd_h2otddwm5uwujlye3qyxmjkphaPattern: ^[A-Za-z0-9_-]{1,48}$

Header parameters

x-correlation-idstringOptional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Responses

200

All needed information related to the requested end user (consumer).

application/json

The following objects represent the personal information of the end user (consumer).

languagestring · min: 5 · max: 5Optional

Language of the end user (consumer). Based on ISO format for language (ISO 639–1) and an alpha-2 country code (ISO 3166–1 alpha-2). The language must be lowercase, and the country must be uppercase ideally. The language and country should be separated using a minus character "-".
Note: This field is mandatory for Click to Pay.

Example: en-USPattern: ^[a-z]{2}-[a-zA-Z]{2}$

firstNamestring · min: 1 · max: 128Required

First name of the end user (consumer).
Note: This field is mandatory for Click to Pay.

Example: JohnPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,128}$

middleNamestring · min: 1 · max: 128Optional

Middle name of the end user (consumer).

Example: JohnPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,128}$

lastNamestring · min: 1 · max: 128Required

Last name of the end user (consumer).
Note: This field is mandatory for Click to Pay.

Example: SmithPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,128}$

dateOfBirthstringOptional

Date of Birth.

Example: 1990-01-25Pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$

titlestring · min: 1 · max: 40Optional

Title of the end user (consumer).

Example: Mr.Pattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,40}$

emailstringOptional

Email of the end user (consumer).
Note: This field is mandatory for Click to Pay (Mastercard).

Example: [email protected]Pattern: ^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,15}$

403

Forbidden (Invalid state)

404

End user (consumer) was not found

application/json

500

Internal server error

application/json

get

/banking/d1/v1/issuers/{issuerId}/consumers/{consumerId}?cardId=<cardId>

HTTPcURLJavaScriptPython

GET /banking/d1/v1/issuers/{issuerId}/consumers/{consumerId}?cardId=<cardId> HTTP/1.1
Host: YOUR_DOMAIN_NAME
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "language": "en-US",
  "firstName": "John",
  "middleName": "John",
  "lastName": "Smith",
  "dateOfBirth": "1990-01-25",
  "title": "Mr.",
  "email": "[email protected]",
  "mobilePhoneNumber": {
    "countryCode": "+420",
    "phoneNumber": "777222333"
  },
  "residencyAddress": {
    "line1": "Street#1",
    "line2": "Street #2",
    "city": "Prague",
    "state": "CZ",
    "zipCode": "140 00",
    "countryCode": "CZ"
  }
}