1. Check License

The first step for registration is getting license information from the merchant. The license could be a Saudi freelance certificate or a Saudi Commercial Registration.


POST /api/partner/register/check-license

Request Headers

AuthorizationYesBearer token provided by Authentication Endpoint
AcceptYesIt must be set to application/JSON.
Content-TypeYesIt must be set to application/JSON.
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"

Request Body Parameters

Field nameField typeDescriptionRestrictions
registrationTypeEnum [freelancer, cr]The value must be either "freelancer" for the Freelance Certificate or "cr" for Commercial Registration.The value must be only "freelancer" or "cr."
licenseNumberStringIt will contain either the number of the freelance certificate or the number of the commercial registration.This field could have any value or license number.
mobileNumberStringThe mobile number of the merchantThis field must have only Saudi mobile numbers.
hijriYearStringThe Hijra year of the merchant's birth date.Year value in Hijra (e.g., 1390)
hijriMonthStringThe Hijra month of the birth date of the merchantMonth value in the year (e.g., 01, 02)
hijriDayStringThe Hijra day of the birth date of the merchantDay value in the month (e.g., 10, 30)
partnerProfileNoStringThe partner profile no. It will be given upon signing the contract with Paylink.

An example of the request is as follows:

  "registrationType": "cr",
  "licenseNumber": "7012345678",
  "mobileNumber": "00966512345678",
  "hijriYear": "1401",
  "hijriMonth": "02",
  "hijriDay": "03",
  "partnerProfileNo": "01234567"

Success Response

After submitting the above input, the response details are as follows:

Field nameField typeDescription
signatureStringThis is a signature that must be passed to the next step. It is used for data integrity.
mobileStringIt will contain the mobile number of the merchant.
sessionUuidStringThis field will contain a random session UUID for this registration process.

Example of the response:

  "signature": "ae135f2506dc3c44152d62265419c09e****",
  "mobile": "00966512345678",
  "sessionUuid": "96ea8e22-edef-414b-9724-3bd2d494b710"