Adyen for Platforms: Account API
  1. Verification
Adyen for Platforms: Account API
  • Verification
    • Trigger verification
      POST
    • Delete bank accounts
      POST
    • Delete legal arrangements
      POST
    • Delete payout methods
      POST
    • Delete shareholders
      POST
    • Delete signatories
      POST
    • Get documents
      POST
    • Upload a document
      POST
  • Accounts
    • Close an account
      POST
    • Create an account
      POST
    • Update an account
      POST
  • Account holders
    • Close an account holder
      POST
    • Close stores
      POST
    • Create an account holder
      POST
    • Get an account holder
      POST
    • Get a tax form
      POST
    • Suspend an account holder
      POST
    • Unsuspend an account holder
      POST
    • Update an account holder
      POST
    • Update payout or processing state
      POST
  1. Verification

Trigger verification

POST
/checkAccountHolder
Verification
Triggers the verification of an account holder even if the checks are not yet required for the volume that they are currently processing.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/checkAccountHolder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string",
    "accountStateType": "LimitedPayout",
    "tier": 0
}'
Response Response Example
200 - Example 1
{
    "invalidFields": [
        {
            "errorCode": 0,
            "errorDescription": "string",
            "fieldType": {
                "field": "string",
                "fieldName": "accountCode",
                "shareholderCode": "string"
            }
        }
    ],
    "pspReference": "string",
    "resultCode": "string"
}

Request

Body Params application/json
accountHolderCode
string 
required
The code of the account holder to verify.
accountStateType
enum<string> 
required
The state required for the account holder.
Permitted values: Processing, Payout.
Allowed values:
LimitedPayoutLimitedProcessingLimitlessPayoutLimitlessProcessingPayoutProcessing
tier
integer <int32>
required
The tier required for the account holder.
Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body
invalidFields
array[object (ErrorFieldType) {3}] 
optional
Contains field validation errors that would prevent requests from being processed.
errorCode
integer <int32>
optional
The validation error code.
errorDescription
string 
optional
A description of the validation error.
fieldType
object (FieldType) 
optional
The type of error field.
pspReference
string 
optional
The reference of a request. Can be used to uniquely identify the request.
resultCode
string 
optional
The result code.
🟢202Accepted - the request has been accepted for processing, but the processing has not been completed.
🟠400Bad Request - a problem reading or understanding the request.
🟠401Unauthorized - authentication required.
🟠403Forbidden - insufficient permissions to process the request.
🟠422Unprocessable Entity - a request validation error.
🔴500Internal Server Error - the server could not process the request.
Next
Delete bank accounts
Built with