Validate Beneficiary

Testing Env

https://api.uat.sokin.com

POST

/beneficiaries/validate

Provide beneficiary_id for existing beneficiaries, iban/bic/account_name to validate before creation, or email for an e-transfer auto-deposit enrolment check.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.uat.sokin.com/beneficiaries/validate?corporateReference=' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "beneficiaryId": "string",
    "email": "user@example.com",
    "iban": "stringstringstr",
    "accountName": "string",
    "bic": "stringst",
    "sortCode": "string",
    "accountNumber": "string"
}'

Response Example

200 - Example 1

{
    "message": "string",
    "data": {
        "isValid": true,
        "results": [
            {
                "currencyCode": "string",
                "paymentRail": "string",
                "validationType": "FORMAT",
                "status": "not_validated",
                "details": "string",
                "actualName": "string"
            }
        ],
        "autodepositEnrolled": true,
        "registrationName": "string",
        "legalName": "string",
        "securityQaRequired": true,
        "fields": [
            {
                "name": "string",
                "fieldType": "string",
                "min": 0,
                "max": 0,
                "isRequired": true,
                "allowedValues": [
                    "string"
                ],
                "conditions": {
                    "property1": {
                        "paymentRail": [
                            "string"
                        ]
                    },
                    "property2": {
                        "paymentRail": [
                            "string"
                        ]
                    }
                },
                "requiredForPaymentRails": [
                    "string"
                ],
                "visibility": "conditional",
                "conditionalOn": "string",
                "revalidateOn": "string",
                "fixedValue": "string"
            }
        ]
    }
}

Modified at 2026-09-02 15:18:01

Delete Beneficiary

List Financial Institutions