API - Description - IDMobile - Simswap - Response

Support DQE

Simswap success response

If the request is successful, the API returns the following JSON response:

Key	Description	Format
status	Status label.	STRING
operator	Phone number operator.	STRING
swapped	Indicates whether the SIM card has been swapped (`true` or `false`).	STRING

Example:

{
  "status": "success",
  "operator": "Orange",
  "swapped": "false"
}

If the request fails, the API returns the following structure:

Key	Description	Format
status	Request status.	STRING
error_type	Error label detailed in the table below.	STRING
error_id	Error code detailed in the table below.	STRING(2)

Error code details:

Error ID	Error type	Description
01	invalid request	The request is not valid.
02	invalid licence key	The licence is not valid.
04	invalid scope	Invalid scope.
05	missing or empty parameter (user_infos) for this scope	A required parameter is missing for the requested scope.
06	bad parameter format (user_infos) is not a valid JSON	The `user_infos` parameter is not valid JSON.
07	missing mandatory key in user informations (phone)	The `phone` key is mandatory in the `user_infos` parameter for this operator.
09	ineligible phone number	The phone number is not eligible for the solution.
10	invalid phone number	The phone number does not exist.
11	phone number is empty	The phone number is empty.
12	phone check failed	The operator verification failed.
13	operator [Operator Name] not found	The operator could not be found.
14	operator [Operator Name] not authorized for this licence	Your licence is not authorized for this operator.
15	operator [Operator Name] not supported yet	The solution is not yet available for this operator.
16	operator [Operator Name] unreachable	The operator could not be contacted.
17	scope not supported by this operator [Operator Name] yet	This scope is not supported by the operator.
30	invalid or expired token	The token has expired.

Example:

{
  "status": "error",
  "error_type": "invalid phone number",
  "error_id": "10"
}

Related to

0 out of 0 found this helpful