API Result Codes

Result codes can help with troubleshooting the scenario.

General rule:

  • Result Code = 0 means that operation went successfully
  • Result Code > 0 means that there were some problem with the scenario execution

Result Codes

Code/Range Message Description
<0,0>
0 Success Scenario finished successfully. Message differs use-case per use-case
<1000,1999> Warnings
1001 Document data integrity issue Document verification warning
1002 Document expired Document verification warning
1003 Document security check failed Document verification warning
1004 Search matched with exceeded max hits AML warning
<3000,3999> Internal service errors
3001 Internal service error Contact Thales representative.
<4000,4299> Missing input errors
4001 Missing input Mandatory inputs are missing.
4002 Missing userId Mandatory input: userID is missing.
4003 Missing transaction data UserID provided is invalid.
4004 Missing applicationID
4005 Missing OTP
4006 Missing Document for verification Mandatory document input for verification is missing in request
4007 Missing Face for verification Mandatory Face document input for verification is missing in request
4008 Missing Person for search
4009 Missing visit ID Missing FPP visit ID
<4300,4499> Invalid input errors
4301 Invalid input
4302 Invalid userId
4303 Invalid authentication credentials
4304 Invalid transaction data
4305 Invalid applicationID
4306 Invalid OTP
4307 Invalid Document for verification Invalid IDV Input Document
4308 Invalid Face for verification Invalid IDV Input Face
4309 Invalid Person for search Invalid AML Input
4315 Invalid input data for channel selection Invalid channel selection inputs needed for document verification
4316 Unexpected Face data present Face data present in request for use-case without Face recognition
4317 Unexpected field in Document input present Document input object contains a field of unexpected name
4318 Unexpected field in Face input present Face input object contains a field of unexpected name
4319 Unexpected field in input present Other disallowed field present in input
4320 Invalid document’s Size input Document input contains invalid value of optional sub-field “size”
<4500,4999> Invalid state errors
4501 Invalid state
4502 Invalid user state
4503 User revoked
4504 User is blocked
4505 User is locked
4506 Invalid device state
4507 Device is revoked
4508 Device is locked
4509 Device is blocked
4510 Device is initialized
4511 Insufficient privileges
4512 Authentication denied by user
4600 Unable to verify document IDV Document Error
4601 Unable to read document MRZ IDV Document Error
4602 Unable to recognize document IDV Document Error
4603 Document QA not passed IDV Document Error
4604 Document QA not done IDV Document Error
4611 Face mismatch IDV Face Error
4612 Face quality bad IDV Face Error
4702 Bad request AML error
<5000,5999> Internal service errors
5xxx Internal service error Contact Thales representative.