FreelancerVerification

Fetches the status of a freelancer certificate for the provided Certificate Number.

Unique resource name : av.v2.kyc.certificate_status

Important!:

  • The Certificate Number must be between 6-14 digits.
  • This endpoint retrieves the current status of the freelancer's certificate.
get/api/v2.0/av/FreelancerVerification/GetCertificateStatus

Request

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

Query parameters

certificateNumberstring required

The unique Certificate Number for which to fetch the status. Ensure the number is between 6-14 digits and adheres to validation rules.

Response

Returns the certificate status details, including the verification status and other associated information.

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

Example response

{
  "data": {
    "result": {
      "expiryDate": "2025-01-01T00:00:00Z"
    }
  }
}

Changes

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