Base URL: https://demo-api.incodesmile.com — Incode demo environment
Returns stored eKYC verification request/response data for the interview associated with the caller's session token.
Path & query parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
api-version |
header | string | yes |
Responses
200
OK
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
userData |
ExternalVerificationRequest | ||
userData.plugins |
array[string] | ||
userData.source |
string | Enum: US_DRIVERS_LICENSE_1, US_TELCO_1, US_TELCO_2, US_TELCO_4, US_TELCO_5, US_CREDIT_BUREAU_1, US_CREDIT_BUREAU_3, US_ADDRESS_1, US_CONSUMER_1, MX_CONSUMER_1, MX_CONSUMER_2, BR_GOVT_1, BR_CPF_1, CA_RES_CREDIT, CA_CREDIT_FINTRAC, UK_CREDIT_BUREAU_1, UK_VOTER_REGISTER, ES_PHONE_REGISTER_2, CL_1, AR_1, AR_RES_REGISTER, AR_CREDIT_BUR_1, GR_1, GT_1, CR_1, CO_1, PHONE_RISK_1, PHONE_RISK_2, EMAIL_RISK_1, RISK_ADDONS_ONLY, GH_CARD_VERIFY_1, PE_MIGRATION_INSTITUTE, KE_IDENTIFYAFRICA, INDIA_PAN, IN_DMV, NG_MONO_BVN, NG_MONO_NIN, US_CREDIT_TELCO, PH_RES_CREDIT, VE_CIVIL_REGISTER, CO_CIVIL_REGISTER_1, MX_CIVIL_REGISTER_2 |
|
userData.fullName |
string | ||
userData.firstName |
string | ||
userData.middleName |
string | ||
userData.surName |
string | ||
userData.email |
string | ||
userData.street |
string | ||
userData.houseNo |
string | ||
userData.postalCode |
string | ||
userData.countryCode |
string | ||
userData.phone |
string | ||
userData.state |
string | ||
userData.city |
string | ||
userData.ssn |
string | ||
userData.dateOfBirth |
string | ||
userData.ipAddress |
string | ||
userData.taxIdStatus |
string | ||
userData.nationality |
string | ||
userData.dlNumber |
string | ||
userData.dlExpireAt |
string | ||
userData.dlState |
string | ||
userData.last4SSN |
string | ||
userData.idNumber |
string | ||
userData.panNumber |
string | ||
riskData |
PremiumExternalVerification | ||
riskData.level |
string | ||
riskData.verifications |
object | ||
riskData.income |
Income | ||
riskData.income.status |
string | ||
riskData.income.range |
string | ||
riskData.employment |
Employment | ||
riskData.employment.status |
string | ||
riskData.employment.type |
string | ||
riskData.employment.sector |
string | ||
riskData.reasonCodes |
array[VerificationReasonCodes] | ||
riskData.reasonCodes.key |
string | ||
riskData.reasonCodes.reasonCodes |
array[ReasonCode] | ||
riskData.reasonCodes.reasonCodes.reasonCode |
string | Enum: A40SS, A70SS, A4070SS, AASE, ACV, ADC, ADCMS, ADCUD, AFAEI, AFM, AFMNCC, AFMSCC, AHNI, AHR, AIA, AII, AIR, AMCC, AMI, AMICC, AMICCMM, AMICCSE, ANA, AND, ANF, APA, APAI, APCC, APNV, ARNF, ASC, ASCV, ASDL, ASU, AUICCM, AWS, EA1Y, EA2Y, EA4M, EA4Y, EA6M, EAC1F, EACMF, EADP, EAF1, EAF2, EAF3, EAF4Y, EAFC, EAG1, EAG2, EAG3, EAG4, EAG5, EAG6, EAHF, EALLI, EALSM, EALTW, EAM, EAMC, EAMF, EAMI, EAMP, EANA, EANE, EANI, EANP, EAPF, EAQ3, EAQ4, EAQM, EASI, EAVQ, EAW, EAY, ED4M, EDCH, EDCO, EDDN, EDHA, EDHC, EDHI, EDHN, EDI, EDL, EDLC, EDM, EDNP, EDPR, EDVH, EDVHC, EDVHI, EE24, EE90, EEPEII, EMA24, EMA90, ESG24, ESG90, EVS24, EVS90, P2OSOV, P3OSOV, P4OSOV, P5OSOV, PA2M, PA3M, PA15, PA24, PABA, PABM, PACF, PADU, PAE, PAHR, PAIN, PALT, PAM, PAMA, PAML, PANN, PANV, PAPM, PAPO, PAUD, PAV, PAVN, PAW, PBL, PBOT, PCC, PDI, PDL, PDLA, PE24, PE90, PECD, PELT, PES90, PES, PFIS, PFN, PFOI, PFOS, PFRD, PH90, PHAI, PHAO, PHLT, PHRL, PHSLT, PILE, PINV, PLEA, PLLT, PLS, PLST, PMA24, PMA90, PMAE, PMAIC, PMAOC, PMAOP, PMAOT, PML, PMNA, PMO, PMS, PMST, PMU, PMVS, PN3M, PNC, PNMB, PNN, PNNS, PNO, PNPB, PNRR, PNS, PNU, POD, PPC3, PPC5, PPC6, PPC9, PPGR, PPN, PPPH, PPRT, PPV, PRC, PRCO, PRM, PROM, PRP, PRSA, PRSK, PRSV, PSCD, PSDBM, PSFE, PSG24, PSG90, PSHRSN, PSM90, PSMDB, PSMRN, PSMSN, PSTF, PTFN, PTL, PTO, PVLA, PVLS, PVMN, PVOIP, PVRC, PVS24, PVS90, PVST, PVSTF, TANO, TDDA, TFAD1, TFADF, TFADI, TFVE, TFVI, TH3AA, TH3AH, TH3AI, TH3AO, TH3AS, TH3BO, TH3CH, TH3DB, TH3DI, TH3ED, TH3FG, TH3FR, TH3IT, TH3MR, TH3NN, TH3OM, TH3PB, TH3PH, TH3PR, TH3RI, TH3SA, TH3SF, TH3SM, THAAA, THAAH, THAAI, THAAO, THAAS, THABO, THACH, THADB, THADI, THAED, THAFG, THAFR, THAIT, THAMR, THANN, THAOM, THAPB, THAPH, THAPR, THARI, THASA, THASF, THASM, THPAA, THPAH, THPAI, THPAO, THPAS, THPBO, THPCH, THPDB, THPDI, THPED, THPFG, THPFR, THPIT, THPMR, THPNN, THPOM, THPPB, THPPH, THPPR, THPRI, THPSA, THPSF, THPSM, THTAH, THTAV, THTBE, THTBP, THTDI, THTED, THTES, THTFG, THTFR, THTGP, THTHE, THTIA, THTIH, THTIP, THTMX, THTNN, THTOM, THTPR, THTRP, THTSG, THTVP, TIAWB, TIAWF, TINO, TL3AA, TL3AH, TL3AI, TL3AO, TL3AS, TL3BO, TL3CH, TL3DB, TL3DI, TL3ED, TL3FG, TL3FR, TL3IT, TL3MR, TL3NN, TL3OM, TL3PB, TL3PH, TL3PR, TL3RI, TL3SA, TL3SF, TL3SM, TLAAA, TLAAH, TLAAI, TLAAO, TLAAS, TLABO, TLACH, TLADB, TLADI, TLAED, TLAFG, TLAFR, TLAIT, TLAMR, TLANN, TLAOM, TLAPB, TLAPH, TLAPR, TLARI, TLASA, TLASF, TLASM, TLGPD, TLPAA, TLPAH, TLPAI, TLPAO, TLPAS, TLPBO, TLPCH, TLPDB, TLPDI, TLPED, TLPFG, TLPFR, TLPIT, TLPMR, TLPNN, TLPOM, TLPPB, TLPPH, TLPPR, TLPRI, TLPSA, TLPSF, TLPSM, TLTAH, TLTAV, TLTBE, TLTBP, TLTDI, TLTED, TLTES, TLTFG, TLTFR, TLTGP, TLTHE, TLTIA, TLTIH, TLTIP, TLTMX, TLTNN, TLTOM, TLTPR, TLTRP, TLTSG, TLTVP, TMAI, TMFSI, TNAPD, TNASM, TNPID, TNPIE, TNPIN, TNPIP, TNPIR, TNPIS, TNPIZ, TNPMS, TOAB, TOAF, TPAI, TPDNV, TPSMT, TSAC, TSAF, TSBF, TSBG, TSBH, TSBI, TSBJ, TBK, TSBN, TSBO, TSCG, TSCH, TSDC, TSDD, TSDE, TSDF, TSDG, TSDH, TSDI, TSDJ, TSDK, TSDL, TSDM, TSDN, TSDO, TSDP, TSMA, TSMB, TSMC, TNSA, TSNB, TSNC, TSOA, TSKU, TSLI, TSLJ, TSLK, TSLN, TSLO, TSDV, TSNA, TSNV, TSOD, TSOP, TSPNA, TSPNM, TSR, TSRD, TSRF, TSSF, TSTUT, TTIQ, TXHR, TXMTW, TXNA, TXR, TXTW, TXVHR, TSRP |
|
riskData.reasonCodes.reasonCodes.description |
string | ||
riskData.additionalVerificationInfo |
AdditionalVerificationInfo | ||
riskData.additionalVerificationInfo.creditFileDetails |
CreditFileDetails | ||
riskData.additionalVerificationInfo.creditFileDetails.creditFileNumber |
string | ||
riskData.additionalVerificationInfo.creditFileDetails.creditFileCreationDate |
string |
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 |