Verification Status
GET {{baseUrl}}/bglid/recipients/{{recipientId}}/status?demo={{demo}}&jurisdiction={{jurisdiction}}
Response Body
| Key | Datatype | Constraints/Comments | Example |
|---|---|---|---|
| processState | String (Enum) Current supported values: AWAITINGUSERINPUT, IN_PROGRESS, COMPLETE | The current processing state of this user verification. - AWAITINGUSERINPUT - still waiting on the user to complete verification - IN_PROGRESS - The user has provided their data; messages are currently in flight with remote systems and the verification is in progress - COMPLETE - The verification process has finished. Additional results are available on the object at this state only | |
| status | String (Enum) Current supported values: UNCHECKED, REFER, SUCCESS, MANUALSUCCESS, FAILURE, MANUALFAILURE, MIXED | The actual verification status for this recipient | |
| checkDateTime | String | ISO Timestamp of when the check took place in UTC time without timezone portion. | “2023-07-27T01:32:09.422” |
| riskLevel | Integer (0-100) | Estimated risk level for this recipient | |
| base64PdfReport | String | BGLiD Generated PDF report of the results, in a BASE64 format. | “JVBERi0xLj...Cg==” (very long string) |
| completedChecks | Object (TBD) | An object including all of the completed checks | See below |
| potentialMatches | Array of objects (TBD) | An array of objects including all potential matches (if any) found for this recipient | See below |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
demo | string | ||
jurisdiction | string | Allowed values "AUSTRALIA" / "NEW_ZEALAND" / "SINGAPORE" |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
{"processState":"AWAITING_USER_INPUT"}