Field description

Field description

S/N	Parameter Name	Description	Comment/ Field length
1	responseCode	The request response code	00 means the request was successful
2	responseDescription	The request response message	The description of the status code
3	username	The client api username
4	OtherInfo	The secret key to be used for the encryption of request messages
5	ClientCode	The client code of the requesting client	Varchar(6) Mandatory
6	requestID	The sim swap request id which must be prefixed by the client code	Varchar (20) Mandatory
7	telco	The alias of the telco of the mobile subscriber	Varchar (3) Mandatory Note: MTN : MTN AIRTEL: AIR  ETISALAT: ETI GLOBACOM: GLO
8	phoneNumber	The phone number of the mobile subscriber	Varchar (15) Must be prefixed with “234”
9	simSwapMode	The sim swap status of the mobile subscriber
10	simSwapDate	The date the sim was swapped or recycled

Status Code and Description

S/N	Code	Description
1	00	Successful
2	01	Empty Request
3	02	Service Not Available
4	10	Json Generation Exception
5	11	Json Mapping Exception
6	20	JWT Expired Signature Exception
7	21	JWT Signature Exception
8	30	Invalid Parameters
9	31	Invalid User Authorization Header
10	32	Invalid Request Id Length
11	33	Invalid Request Id Format
12	34	Invalid Phone Number Length
13	40	No API User Found
14	50	Database Exception
15	51	General Exception
16	52	SimSwap Exception
17	60	Constraint Exception
18	61	Security Exception
19	70	Not Authorized
20	80	Duplicate Request

HTTP Response Code

S/N	Code	Description
1	200	Request successfully executed
2	400	Resource Not Found
3	500	Server Error