BeneficiaryVerification

Retrieves the name of the beneficiary associated with the specified IBAN.

Unique resource name : av.v2.beneficiary_verification.match

Important!:

  • The IBAN must be a valid KSA IBAN.
  • The request model must include all required details for successful beneficiary retrieval.
post/api/v2.0/av/BeneficiaryVerification/Match

Request

  • Base URL: https://sandbox.sparefinancial.sa
  • URL: https://sandbox.sparefinancial.sa/api/v2.0/av/BeneficiaryVerification/Match
  • Auth: API key in header Authorization

Request body

beneficiaryNamestring nullable

Name of the beneficiary to verify or pay.

ibanstring required

Account IBAN.

Example request

{
  "iban": "SA0380000000608010167519"
}

Response

Retrieval was successful. The response includes the beneficiary name and associated details.

error'INVALID_DATA' | 'ACCOUNT_VERIFICATION_FAILED' | 'SERVER_ERROR' | 'SUBSCRIPTION_EXPIRED'
errorDescriptionobject nullable

Example response

{
  "data": {
    "executionDate": "2025-01-01T00:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.