Register Devices

Make a Compliance CSID API request

Registering a device such as POS machine, Invoicing system, web application, etc.. with zatca is achived by calling compliance CSID API.

API Referance

POST {{baseurl}}/api/compliance

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Validation	Description
commonName	string	Mandatory	Name of asset tracking number used by tax payer
email	string	Mandatory	E-Mail address of the organization
location	string	Mandatory	Location of the company branch
companyName	string	Mandatory	Name of the company
vatNumber	string	Mandatory	VAT registread number
isRequiredSimplifiedDoc	boolean (true/false)	Mandatory	If this compliance certificate need ability to submit simplified invoices (B2C) make it true. otherwise false
isRequiredStandardDoc	boolean (true/false)	Mandatory	If this compliance certificate need ability to submit standard invoices (B2B) make it true. otherwise false
deviceSerialNumber1	string	Mandatory	Serial number of invoicing device part 1
deviceSerialNumber2	string	Mandatory	Serial number of invoicing device part 2
deviceSerialNumber3	string	Mandatory	Serial number of invoicing device part 3
regAddress	string	Mandatory	Register address of the branch of company
businesscategory	string	Mandatory	Business category
otp	string	Mandatory	OTP received from fatoora portal

Samples

Sample Request

{
    "commonName" : "Jeem",
    "email": "[email protected]",
    "location": "Dammam",
    "companyName": "Jeem IT",
    "vatNumber": "310565828400003",
    "isRequiredSimplifiedDoc": true,
    "isRequiredStandardDoc": true,
    "deviceSerialNumber1": "stackcue",
    "deviceSerialNumber2": "ESGUnit",
    "deviceSerialNumber3": "9sfgbdb02-665",
    "regAddress": "KHOBAR",
    "businesscategory": "Software and IT",
    "otp": "272482"
}

Sample success response

{
    "zatcaResponse": {
        "requestID": 1234567890123,
        "dispositionMessage": "ISSUED",
        "binarySecurityToken": "TUlJQ0FEQ0NBYWFnQXdJQkFnSUdBWkZTblJYY01Bb0dDQ3FHU000OUJBTUNNQlV4RXpBUkJnTlZCQU1NQ21WSmJuWnZhV05wYm1jd0hoY05NalF3T0RFME1qQXpPREkzV2hjTk1qa3dPREV6TWpFd01EQXdXakJSTVJVd0V3WURWUVFEREF4emRHRmphMk4xWlM1amIyMHhEekFOQmdOVkJBc01Ca1JoYlcxaGJURWFNQmdHQTF....",
        "secret": "sajT6YmbFYz96sySOJAwuaWPeFQY4MjXZV6IxamaB+I=",
        "errors": null
    },
    "stackcueHelper": {
        "overallStatus": 1,
        "stackcueComplianceIdentifier": "4786f351-4114-440d-a7d1-5dd7d2ee576a",
        "CerIssueDate": "14-08-2024 20:38:27",
        "CerExpDate": "13-08-2029 21:00:00"
    }
}

Sample Error Response

{
    "errors": [
        "[vatNumber] VAT number should start and end with 3."
    ],
    "stackcueHelper": {
        "overallStatus": 0
    }
}