Base URL: https://demo-api.incodesmile.com — Incode demo environment
Send OTP code obtained through SMS to validate an onboarding. Phone number is obtained from interview data, so phone step it's required. Success will be false if code sent doesn't match.
Path & query parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
code |
query | string | yes | |
api-version |
header | string | yes |
Responses
200
OK
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | Flag indicating request passed successfully. | |
sessionStatus |
string | Session status Enum: Alive, Closed, Deleted |
400
Bad Request
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
timestamp |
integer (int64) | UTC timestamp in milliseconds | |
status |
integer (int32) | Custom error code or HTTP status code | |
error |
string | HTTP status error | |
message |
string | Custom error message | |
path |
string | Endpoint path | |
details |
object | Custom error details |