AccountVerification

Verifies if the account ID matches the provided identification details.

Unique resource name : av.v2.account_verification.id_match

Important!:

  • The provided IBAN must be a valid KSA IBAN.
  • The idValue must be a valid KSA national ID, Iqama number, or registration number.
  • Ensure the request model adheres to the required format for successful validation.
post/api/v2.0/av/AccountVerification/IdMatch

Request

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

Request body

ibanstring required

Account IBAN.

idType'NATIONAL_ID' | 'COMPANY_REGISTRATION_NUMBER' | 'IQAMA' | 'UNN' | 'UNKNOWN' required
idValuestring required

Identification value, matching the selected ID type.

Example request

{
  "iban": "SA0380000000608010167519"
}

Response

Verification was successful. The response includes the verification 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.