Loading developer portal
Preparing the API reference and documentation.
Loading developer portal
Preparing the API reference and documentation.
This endpoint implements OAuth 2.0 Client Credentials flow for machine-to-machine authentication. Upon successful authentication, a JWT token is returned which must be included in the Authorization header of all subsequent API requests.
application/json
The authentication request containing client ID and client secret.
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Verifies whether the provided mobile numbers are registered and active in the system.
This endpoint requires Bearer (JWT) authentication obtained from /auth/authenticate.
Behavior:
+, 00 or local 0).foundNumbers and notFoundNumbers.Limits & validation:
mobileNumbers cannot be null or empty.VALIDATION_ERROR.Common error codes: INVALID_PAYLOAD, EMPTY_MOBILE_NUMBERS, MAX_ITEMS_EXCEEDED, VALIDATION_ERROR, MOBILE_NUMBERS_NOT_FOUND, DB_VERIFICATION_ERROR.
Bearer Please enter into field the word 'Bearer' followed by a space and the JWT value.
In: header
application/json
The verification request containing a list of mobile numbers to verify.
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
Retrieves all delivery addresses and customer delivery preferences for the specified mobile numbers.
This endpoint requires Bearer (JWT) authentication obtained from /auth/authenticate.
Behavior:
+, 00 or local 0).Address objects.Limits & validation:
mobileNumbers cannot be null or empty.VALIDATION_ERROR.Common error codes: INVALID_PAYLOAD, EMPTY_MOBILE_NUMBERS, MAX_ITEMS_EXCEEDED, VALIDATION_ERROR, ADDRESSES_NOT_FOUND, DB_REACH_ERROR.
Bearer Please enter into field the word 'Bearer' followed by a space and the JWT value.
In: header
application/json
The reach request containing a list of mobile numbers to retrieve addresses for.
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
Sends a notification to the user using their Emirates Id or phone number.
This endpoint requires Bearer (JWT) authentication obtained from /auth/authenticate.
Behavior & rules:
from, to, subject and at least one of text or html.to) can be any special receiver codes (trade license tr..., contract ca..., phone number of 12 digits, Emirates ID 784 + 12 digits, or ERN of 19 alphanumeric characters). Invalid formats return INVALID_RECIPIENT_ADDRESS.Validation & errors:
filename and a valid HTTP/HTTPS url.INVALID_PAYLOAD, VALIDATION_ERROR, SENDER_NOT_ALLOWED, RECEIVER_DOMAIN_NOT_ALLOWED, INVALID_RECIPIENT_ADDRESS, EMAIL_SEND_FAILED, SENDER_VALIDATION_ERROR, EMAIL_SEND_ERROR.On success the endpoint returns a confirmation including to, subject and an eventId for the published email event.
Bearer Please enter into field the word 'Bearer' followed by a space and the JWT value.
In: header
application/json
The email request containing sender, recipient, subject, content, and optional attachments.
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json