Validate Beneficiaries

Testing Env

https://api.uat.sokin.com

POST

/beneficiaries/batch-validation

Validate beneficiary payloads without persisting. Returns per-item validation results with caller references.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

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/batch-validation' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "payloads": [
        {
            "reference": "string",
            "displayName": "string",
            "entityType": "string",
            "countryCode": "string",
            "currencyCode": "string",
            "paymentRail": "string",
            "bankAccount": {
                "property1": "string",
                "property2": "string"
            },
            "eTransfer": {
                "property1": "string",
                "property2": "string"
            },
            "virtualAccount": {
                "property1": "string",
                "property2": "string"
            },
            "sokinInternal": {
                "property1": "string",
                "property2": "string"
            },
            "individual": {
                "property1": "string",
                "property2": "string"
            },
            "company": {
                "property1": "string",
                "property2": "string"
            },
            "address": {
                "property1": "string",
                "property2": "string"
            },
            "providerMetadata": {
                "property1": "string",
                "property2": "string"
            },
            "property1": "string",
            "property2": "string"
        }
    ]
}'

Response Example

200 - Example 1

{
    "message": "string",
    "data": {
        "isValid": true,
        "results": [
            {
                "reference": "string",
                "isValid": true,
                "errors": [
                    {
                        "loc": [
                            "string"
                        ],
                        "message": "string",
                        "type": "string"
                    }
                ]
            }
        ]
    }
}

Modified at 2026-09-03 09:27:01

List Financial Institution Branches

ProviderBankIdentifierRequest