📞#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
Body
codestringRequired

Country Code

Example: 20
phoneNumberstringRequired

Client mobile number

Example: 01xxxxxxxxx
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/PhoneInfo HTTP/1.1
Host: 
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
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/PhoneInfo/SendOtp HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 0
}

#8.3 Validate OTP:

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

post
Authorizations
Body
otpstringRequired

OTP sent to client's mobile.

Example: 686330
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/PhoneInfo/ValidateOTP HTTP/1.1
Host: 
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
Responses
200

Success

application/json
get
GET /Onboarding/api/v1/onboarding/PhoneInfo/GetVerifiedPhones HTTP/1.1
Host: 
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
Body
phoneNumberstringRequired

Client's phone number

Example: +201xxxxxxxxx
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/PhoneInfo/SetDefault HTTP/1.1
Host: 
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
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/PhoneInfo/Approve HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 0
}

Previous#7 BiometricTestNext#9 Email Info

Last updated