CommonVerification

Verifies if the provided IBAN and ID match and retrieves the beneficiary name associated with the IBAN.

Unique resource name : av.v2.account_verification_pro.match

Important!:

  • The IBAN must be a valid KSA IBAN.
  • The idValue must be valid according to the required format (e.g., National ID, Iqama number, or Registration number).
  • The request validates the IBAN and ID match and also fetches the associated beneficiary name.
post/api/v2.0/av/CommonVerification/Match

Request

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

Request body

ibanstring required

Account IBAN.

idType'NATIONAL_ID' | 'COMPANY_REGISTRATION_NUMBER' | 'IQAMA' | 'UNN' | 'UNKNOWN'
beneficiaryNamestring nullable

Name of the beneficiary to verify or pay.

idValuestring required

Identification value, matching the selected ID type.

Example request

{
  "iban": "SA0380000000608010167519"
}

Response

Verification was successful. The response includes details of the matched account and the beneficiary name.

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.