UAE Work Permit Info API

Overview

The UAE Electronic Work Permit Information API provides detailed information about electronic work permits issued in the UAE. It is designed to retrieve data related to company information, work permit specifics, and additional permit details based on the permit number.

Use Case

Human Resources Compliance: Useful for businesses in the UAE to verify and manage the details of electronic work permits for their employees.

Government and Regulatory Bodies: Assists government agencies in monitoring and auditing work permit compliance across different companies.

Immigration and Legal Services: Enables law firms and immigration services to access detailed permit information for their clients for legal and procedural purposes.

API Details

Request Body

curl --location 'https://api-preproduction.signzy.app/api/v3/uae/electronic-work-permit-info' \
--header 'Authorization: <Auth Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "electronicWorkPermitNumber": 74641878
}'

Request Body Parameters

Parameter	Type	Description	Required
electronicWorkPermitNumber	Integer	The unique number identifying the electronic work permit.	Yes

Sample API Response

{
    "result": {
        "CompanyInformation": {
            "EstName": "ANTA TRAVEL & TOURS L.L.C",
            "Category": "2",
            "CompanyCode": "220449",
            "Classification": "Small"
        },
        "ElectronicWorkPermitInformation": {
            "Name": "MOHAMED L RAZAK",
            "Designation": "FOLLOW UP CLERK",
            "EmployeeClassification": "Skilled",
            "ElectronicWorkPermitType": "RENEW ELECTRONIC WORK PERMIT",
            "ExpiryDate": "25/12/2019",
            "ElectronicWorkPermitNumber": "74641878",
            "ElectronicWorkPermitActive": "Cancelled",
            "PaymentNumber": "5B2F0JJ90BB300BQ",
            "PaycardNumber": "8B2F0JJ90BB316",
            "PersonCode": "10015076961107",
            "TransactionNumber": "MB181903347AE"
        },
        "AdditionalElectronicWorkPermitDetails": {
            "ElectronicWorkPermitNumber": "118501486",
            "ElectronicWorkPermitType": "RENEW ELECTRONIC WORK PERMIT",
            "Status": "Active",
            "TransactionNumber": "MB275080924AE"
        }
    }
}

Response Body Parameters

Section	Field	Type	Description
CompanyInformation		Object	Contains details about the company associated with the work permit.
	EstName	String	Establishment name of the company.
	Category	String	Category of the company, typically defining size or type.
	CompanyCode	String	Unique code assigned to the company.
	Classification	String	Classification of the company based on size or type.
ElectronicWorkPermitInformation		Object	Details about the specific work permit.
	Name	String	Full name of the employee.
	Designation	String	Job title or role within the company.
	EmployeeClassification	String	Classification of the employee, e.g., skilled, unskilled.
	ElectronicWorkPermitType	String	Type of the electronic work permit.
	ExpiryDate	String	Expiry date of the work permit.
	ElectronicWorkPermitNumber	Integer	Number of the electronic work permit.
	ElectronicWorkPermitActive	String	Current status of the permit, e.g., active, cancelled.
	PaymentNumber	String	Reference number for the payment associated with the permit.
	PaycardNumber	String	Card number used for the payment.
	PersonCode	String	Unique identifier for the person.
	TransactionNumber	String	Transaction number associated with the permit issuance.
AdditionalElectronicWorkPermitDetails		Object	Additional details about other related work permits.
	ElectronicWorkPermitNumber	Integer	Number of another electronic work permit.
	ElectronicWorkPermitType	String	Type of the additional electronic work permit.
	Status	String	Status of the additional electronic work permit.
	TransactionNumber	String	Transaction number associated with the additional permit.

Error Code and Mapping

{
    "error": {
        "name": "error",
        "message": "Invalid input entered. Valid inputs are dubai,abu_dhabi,sharjah,ras_al_khaima,ajman,fujairah,um_al_qaiwain, zones-corp",
        "status": "400",
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": "400"
    }
}

Error Response Parameters

Parameter	Description
error	This parameter contains the error
error.name	The name of the error
error.message	The error message
error.statusCode	Request Status code from Signzy
error.reason	Reason for error
error.type	Type of the error

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!