📧#9 Email Info

Enroll Allow You to Add Multiple Emails For Each Customer

#9.0 Add New Email :

This API is to add client's email. Client can add up to 5 emails.

post
Authorizations
Body
emailstringRequired

Client's Email

Example: example@domain.com
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/EmailInfo HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "email": "example@domain.com"
}
{
  "status": 0
}

#9.1 Send OTP :

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

post
Authorizations
Responses
200

Success

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

{
  "status": 0
}

#9.2 Validate OTP :

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

post
Authorizations
Body
otpstringRequired

OTP sent to client's email

Example: 456953
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/EmailInfo/ValidateOtp HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "otp": "456953"
}
{
  "status": 0
}

#9.3 Get Verified Emails :

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

get
Authorizations
Responses
200

Success

application/json
get
GET /Onboarding/api/v1/onboarding/EmailInfo/GetVerifiedEmails HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "email": "example@domain.com",
    "isDefault": "true"
  }
]

#9.4 Set Default Email Info :

This API is to set default client's specific email if client has multiple emails.

post
Authorizations
Body
emailstringRequired

Client's email that make it default

Example: example@domain.com
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/EmailInfo/SetDefault HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "email": "example@domain.com"
}
{
  "status": 0
}

#9.5 Finalize Email Info :

This API is to finalize email step.

post
Authorizations
Responses
200

Success

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

{
  "status": 0
}

Previous#8 Phone InfoNext#10 Device Info

Last updated