📧#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

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

emailstringRequired

Client's Email

Example: [e-mail]

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/EmailInfo

HTTPcURLJavaScriptPython

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

{
  "email": "[e-mail]"
}

{
  "status": 0
}

#9.1 Send OTP :

This API is to send OTP to added email. 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/EmailInfo/SendOtp

HTTPcURLJavaScriptPython

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

{
  "status": 0
}

#9.2 Validate OTP :

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

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

otpstringRequired

OTP sent to client's email

Example: 456953

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/EmailInfo/ValidateOtp

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/EmailInfo/ValidateOtp HTTP/1.1
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

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

emailstringRequired

Client's Email

Example: [e-mail]

isDefaultbooleanRequired

True if email is default email, in case client has multiple emails

Example: true

400

BadRequest

application/json

401

Unauthorized

application/json

get

/Onboarding/api/v1/onboarding/EmailInfo/GetVerifiedEmails

HTTPcURLJavaScriptPython

GET /Onboarding/api/v1/onboarding/EmailInfo/GetVerifiedEmails HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "email": "[e-mail]",
    "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

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

emailstringRequired

Client's email that make it default

Example: [e-mail]

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/EmailInfo/SetDefault

HTTPcURLJavaScriptPython

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

{
  "email": "[e-mail]"
}

{
  "status": 0
}

#9.5 Finalize Email Info :

This API is to finalize email 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/EmailInfo/Approve

HTTPcURLJavaScriptPython

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

{
  "status": 0
}