FreelancerVerification

Fetches freelancer certificate details for the provided National ID and Certificate Number.

Unique resource name : av.v2.kyc.freelance_details

Important!:

  • The National ID (NID) and government-issued Certificate Number (CNN) must be valid.
  • The Certificate Number must be between 6-14 digits.
  • This endpoint retrieves detailed information about the freelancer certificate.
post/api/v2.0/av/FreelancerVerification/CertificateDetails

Request

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

Request body

nationalIdstring required

National identity number of the individual.

certificateNumberstring required

Certificate number.

Response

Returns the freelance details, including the certificate status and associated information.

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

Example response

{
  "data": {
    "result": {
      "nationalIdExpiryDate": "2025-01-01T00:00:00Z",
      "certificate": [
        {
          "expiryDate": "2025-01-01T00:00:00Z",
          "issueDate": "2025-01-01T00:00:00Z"
        }
      ]
    }
  }
}

Changes

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