v1

latestOpenAPI 3.0.32026-07-2484569553.1 KB

User info

Data about the end user. Almost all providers only populate the full_name field. We do not recommend relying on any of the other fields for your application.

get/info

Headers

X-Client-Correlation-Idstring

Client-specified ID used to debug requests

X-PSU-IPstring

IP address of the end user requesting data. Necessary to overcome 4 calls per day rate limits

Response

status'Succeeded' | 'Queued' | 'Running' | 'Failed'

Indicates whether the request was successful. 'Queued', 'Running' and 'Failed' can be returned for async requests

Example response

{
  "status": "Succeeded"
}