Update account
Last changes: 12-12-2023
The Update Account API method allows updating the existing account, previously created through a checkout API call, using the provided 'customerAccountId' input parameter.
For detailed information about each object check Data Model.
| Field | Description | Type | Length | Mandatory |
| customerAccountId | Client's identifier of the consumer for which the account will be updated. | String | 255 | Yes |
| Field | Description | Type | Mandatory |
| billingAddress | Consumer's billing address data. See Address in Data model. | Object | Yes |
| consumer | Consumer's personal data, in case the consumer is a physical person. See Consumer in Data Model. | Object | Conditional. Can be present if businessConsumer is missing from the request. |
| businessConsumer | Company data, in case the consumer is a business or a legal entity. See BusinessConsumer in Data Model. | Object | Conditional. Can be present if consumer is missing from the Request. |
-
Path:
-
PATCH {BaseURL}/accounts/{customerAccountId}
-
Header:
-
Content-Type: application/json
Accept-Language: en-US
{
"billingAddress": {
"customerFullName": "Hells Butcher",
"emailAddress": "hells.butcher_001@mail.com",
"address": "Leopoldstrasse",
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE"
},
"consumer": {
"emailAddress": "hells.butcher_001@mail.com",
"customerGroupId": "VIP",
"gender": "m",
"lastName": "Hells",
"firstName": "Butcher",
"middleName": "fon",
"title":"Mr",
"culture": "de-de",
"dateOfBirth": "2000-01-01",
"mobilePhone": "015xx22-2135466",
"isBusinessUser": false,
"taxId": "00745948504594"
},
}| Field | Description | Type | Length |
| partnerReference | Partner service call identifier. | String | 64 |
| statusCode | Status code of the account. Possible values are: ACTIVE, CLOSED, INACTIVE or REJECTED. | String | 10 |
| accFlowStatusCode | Status code of the account flow. | String | 10 |
| twoFAStatusCode | Two Factor Authentication Status Code. Possible values are: 2FADIS-Two Factor Authentication is disabled. 2FANOTCONF- Two Factor Authentication is activated but not configured. 2FAINPROC- Two Factor Authentication is activated and configuration is in process. 2FACONF-Two Factor Authentication is activated and configured. | String | 10 |
| isTwoFASetupCodeRequired | Whether a confirmation of Two-Factor Authentication setup with a verification code is required or not (this code is sent to the user email). | Boolean | |
| providerResponse | External provider data. | Object | |
| providerResponse.complianceData | Compliance data. Check Compliance data below for more info. | Array | |
| requestDateTime | Timestamp of the request in the format defined by ISO 8601. | YYYY-MM-DD | |
| responseCode | The response code. | String | 4 |
| responseDescription | The response description. | String | 512 |
| Field | Description | Type | Length |
| archiveId | Archived check result identifier. | String | 50 |
| trafficLight | The following options are possible: "RED" – hit, "YELLOW" – unsure hit, "GREEN" – no hit. | String | 10 |
| hitType | The following options are possible "SL" – sanctions list, "BL" – black list, "PEP" – publicly exposed person. | String | 10 |
| manualReview | Whether a manual review is required or not. | Boolean | |
| details | List of compliance check details. | Array |
-
Status Code:
-
200 (OK)
-
Header:
-
Content-Type: application/json
Accept-Language: en-US
{
"partnerReference": "PIT-XXX_CUST-1564891230_SgUDBJYhUu",
"statusCode": "ACTIVE",
"accFlowStatusCode": "APPROVEDSV",
"twoFAStatusCode": "2FADIS",
"providerResponse":
{
"complianceData":
[
{
"archiveId": "4108000025015465",
"trafficLight": "YELLOW",
"hitType": "SL",
"manualReview": true,
"details":
[
{
"name": "Falk Quintus",
"birthdate": "19660201"
},
{
"name": "Quintus Falk",
"birthdate": "19660201"
}
],
}
]
},
"requestDateTime": "2021-02-08T17:43:19.027Z",
"responseCode": "0000",
"responseDescription": "Successful execution.",
}