Manage Consumer Information - Field Descriptions
The following page details each of the fields sent in the request and received in the response when using the Manage Consumer Information endpoint.
Request Fields
The following table describes fields that must be included in the body of the request when using the Manage Consumer Information endpoint.
| Field | Description | Mandatory? | Type |
|---|---|---|---|
| customerDetails | Object that contains information on the customer. | Yes | |
| customerReferenceId | An external customer reference provided in the request. | Yes | String |
| The email address of the customer. | Yes | String | |
| phone | The phone number of the customer. | Yes | String |
| firstName | The first name of the customer. | Yes | String |
| middleName | The middle name of the customer. | Yes | String |
| lastName | The last name of the customer. | Yes | String |
| countryCode | The 3 digit country code. | Yes | String |
| language | The 2 digit language code. For example, en. | Yes | String |
| nationalIdentifiers | Object that contains information on the identifiers of the customer. | Yes | |
| type | The identification type for the cardholder. For example, PASSPORT, DRIVING_LICENSE, NATIONAL_IDENTITY. | Yes | String |
| value | The identification number for the cardholder. | Yes | String |
| nationalIdentifiers | End of the nationalIdentifiers object. | ||
| customerDetails | End of the customerDetails object. |
Response Fields
A successful response for the Manage Consumer Information endpoint returns a 202 response with either a unique requestTraceId (where the card network is Visa), or srcCorrelationId (where the card network is Mastercard).
| Field | Description |
|---|---|
| requestTraceId | A unique identifier to trace the request where the card network is Visa. |
| srcCorrelationId | A unique identifier to trace the request where the card network is Mastercard. |
Updated 9 days ago