📞#8 Phone Info

#8.1 Add New Phone:

This API is to add client's phone number. Client can add up to 5 numbers.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

codestringRequired

Country Code

Example: 20

phoneNumberstringRequired

Client mobile number

Example: 01xxxxxxxxx

Responses

200

Success

application/json

statusinteger · enumOptional

Indicates the result of the operation. 0 = Success, 1 = Failed.

Possible values:

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/PhoneInfo

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/PhoneInfo HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "code": "20",
  "phoneNumber": "01xxxxxxxxx"
}

{
  "status": 0
}

#8.2 Send OTP :

This API is to send OTP to added mobile number. OTP will be expired after 10 minutes.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

statusinteger · enumOptional

Indicates the result of the operation. 0 = Success, 1 = Failed.

Possible values:

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/PhoneInfo/SendOtp

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/PhoneInfo/SendOtp HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 0
}

#8.3 Validate OTP:

This API is to validate OTP sent to client's mobile.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

otpstringRequired

OTP sent to client's mobile.

Example: 686330

Responses

200

Success

application/json

statusinteger · enumOptional

Indicates the result of the operation. 0 = Success, 1 = Failed.

Possible values:

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/PhoneInfo/ValidateOTP

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/PhoneInfo/ValidateOTP HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "otp": "686330"
}

{
  "status": 0
}

#8.4 Get Verified Phones :

This API is to get list of client's verified mobile numbers.

get

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

phoneNumberstringRequired

Client's mobile number.

Example: +201xxxxxxxxx

isDefaultbooleanRequired

True if mobile number is default.

400

BadRequest

application/json

401

Unauthorized

application/json

get

/Onboarding/api/v1/onboarding/PhoneInfo/GetVerifiedPhones

HTTPcURLJavaScriptPython

GET /Onboarding/api/v1/onboarding/PhoneInfo/GetVerifiedPhones HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "phoneNumber": "+201xxxxxxxxx",
    "isDefault": true
  }
]

#8.5 Set Default Phone:

This API is to set default client's specific mobile number if client has multiple numbers.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

phoneNumberstringRequired

Client's phone number

Example: +201xxxxxxxxx

Responses

200

Success

application/json

statusinteger · enumOptional

Indicates the result of the operation. 0 = Success, 1 = Failed.

Possible values:

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/PhoneInfo/SetDefault

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/PhoneInfo/SetDefault HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "phoneNumber": "+201xxxxxxxxx"
}

{
  "status": 0
}

#8.6 Finalize Phone Step:

This API is to finalize phone step.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

statusinteger · enumOptional

Indicates the result of the operation. 0 = Success, 1 = Failed.

Possible values:

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/PhoneInfo/Approve

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/PhoneInfo/Approve HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 0
}