Base URL: https://demo-api.incodesmile.com — Incode demo environment
Cross-checks name and date of birth from account creation against data extracted during IDV. Compares the provided data with OCR-extracted data and returns validation score with risk assessment.
Path & query parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
interviewId |
query | string | ||
api-version |
header | string | yes |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | Full name from account creation |
dateOfBirth |
string | yes | Date of birth in YYYY-MM-DD format |
Responses
200
OK
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
sessionId |
string | Session ID that was cross-checked | |
score |
IdentityCrosscheck | Identity cross-check score results | |
score.overall |
ResultBean | Overall validation result | |
score.overall.value |
string | ||
score.overall.status |
string | Enum: OK, WARN, FAIL, UNKNOWN, MANUAL, MANUAL_OK, MANUAL_FAIL, MANUAL_PENDING |
|
score.checks |
object | Individual validation checks | |
score.riskLevel |
string | Risk level assessment | |
success |
boolean | Success indicator | |
errorMessage |
string | Error message if cross-check failed |
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 |
404
Session or IDV data not found
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 |