Skip to main content
POST
/
v1
/
counterparty
/
{id}
/
validate
Initiate bank account verification
curl --request POST \
  --url http://localhost:3001/v1/counterparty/{id}/validate \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "bankAccount": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "iban": "<string>",
    "bic": "<string>",
    "countryCode": "<string>",
    "address": "<string>"
  },
  "paymentProvider": "<string>",
  "status": "VALID",
  "initializedAt": "2023-11-07T05:31:56Z",
  "mailTrackings": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "version": 123,
    "type": "ONBOARDING",
    "status": "ACCEPTED"
  },
  "fullName": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Counterparty ID

Response

200 - application/json
​
bankAccount
object
required

The bank account that was verified.

​
paymentProvider
string
required

The payment provider that was used to verify the bank account.

​
status
enum<string>
required

The status of the bank account verification.

Available options:
VALID,
INVALID,
VALIDATION_FAILED,
PENDING
​
initializedAt
string<date-time>
required

The date and time the bank account verification was initiated.

​
mailTrackings
object
required

The mail tracking information for the verification email.

​
fullName
string
required

The full name of the bank account.

​
id
string

The unique identifier of the entity.

​
createdAt
string<date-time>

The date and time the entity was created.

​
updatedAt
string<date-time>

The date and time the entity was last updated.