API Documentation
POST /persons/:id/verify
Send answers to authentication questions. This will return additional authentication questions or authenticated status.
Headers
KEY |
VALUE |
Content-Type |
application/json |
Authorization |
Bearer {token} |
Request
KEY |
REQUIRED |
COMMENT |
answers |
Yes |
JSON array. Each object has keys “questionId” and “answerId”. E.g., [{“questionId”: “00001”, “answerId”: “0000A”}] |
fulfillment_key |
Yes |
string. Received from /persons/:id/authenticate. |
Response
KEY |
VALUE |
questions |
JSON array. Same format as in the response of /persons/:id/authenticate. These are more questions to be answered. Null unless status code is 200. |
fulfillment_key |
string. Must be used in another call to /person/:id/verify if more questions need an answer. Null unless status code is 200. |
verified |
boolean. |
Status Code
CODE |
COMMENT |
200 |
Verification OK, but more questions are prompted that need answers. |
202 |
Verification completed. Income information complete. |
203 |
Verification complete. Income information incomplete. |
400 |
Wrong payload format. |
401 |
Person not authenticated yet. |
403 |
Not able to verify person. |