API Documentation
POST /persons/:id/authenticate
Send consumer PII to verify identity. This will return a set of authentication questions used to verify the consumer.
Headers
| KEY |
VALUE |
| Content-Type |
application/json |
| Authorization |
Bearer {token} |
Request
| KEY |
REQUIRED |
COMMENT |
| first_name |
Yes |
str |
| last_name |
Yes |
str |
| address |
Yes |
str |
| city |
Yes |
str |
| postal_code |
Yes |
str |
| state |
Yes |
str |
| country |
Yes |
str |
| ssn |
Yes |
Last 4 digits of the social security number. |
| dob |
Yes |
YYYY-MM-DD. |
| phone |
Yes |
str |
Response
| KEY |
VALUE |
| questions |
JSON. Authentication questions used for /persons/:id/verify |
| fulfillment_key |
Required for /persons/:id/verify |
| authenticated |
Boolean value. |
Status Code
| CODE |
COMMENT |
| 200 |
Request OK. Return set of questions with fulfillment_key. |
| 202 |
Request OK. Person is authenticated (no security questions needed). |
| 400 |
Error in payload. |
| 401 |
Personal information belongs to a different person. |
| 403 |
Cannot authenticate this information. |
