Fiat Payments

Verify beneficiary's name

Changed on

Verifies the beneficiary's name. You can call this endpoint before creating a payout via POST /payment/v2/payouts to verify the beneficiary's name and receive a verification ID that can be used in subsequent payout requests.

When using this endpoint, make sure you specify the same beneficiary's names as you will use in the payload of the Initiate Payout request.

post/platform/v1/beneficiaries/verification

Request

Request body

OR

Example request

{
  "accountNumber": "DE89370400440532013000",
  "bankCode": "COBADEFFXXX",
  "firstName": "John",
  "lastName": "Smith",
  "currency": "EUR"
}

Response

OK

idstring uuid required

Unique verification ID that can be used in the X-Verification-Id header of subsequent Initiate Payout requests.

matchStatus'MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'NOT_REQUIRED' | 'NOT_POSSIBLE' | 'TECHNICAL_ERROR' required

Status of the name verification:

  • MATCH: The name provided matches the name of the beneficiary associated with the bank account.

  • PARTIAL_MATCH: The name provided is similar but not exactly the same as the name of the beneficiary associated with the bank account.

  • NO_MATCH: The name provided does not match the name registered for the bank account.

  • NOT_REQUIRED: The name verification is not required for the provided currency.

  • NOT_POSSIBLE: Payee verification is not available for this transfer, so we cannot confirm the recipient's details. Ensure all account information is correct before submitting the payment.

  • TECHNICAL_ERROR: The name verification is not possible due to technical reasons, such as temporary technical errors, or timeouts.

providedNamestring required

Name provided in the verification request.

actualNamestring

Actual name on the bank account. Only present for partial match status.

validUntilstring date-time required

Time when the verification request expires. By default, five minutes from creation.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "matchStatus": "MATCH",
  "providedName": "John Smith",
  "actualName": "J. Smith",
  "validUntil": "2025-01-15T14:30:00Z"
}

Changes

    • breaking

      the / response's property type changed from object to array for status

    • breaking

      the / response's property type changed from object to array for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status