Skip to content

Credits

Credits are needed to perform checks on the Xref platform. This call provides information on the credits remaining on your company's account.

Retrieve Credits

Method GET
Path /credits

This endpoint returns the remaining credits of your company.

Response

200 — application/json

Attributes (object)
AttributeTypeDescription
credits_remainingnumbercompany's remaining credits.
Body
{
    "credits_remaining": 100
}

401 — application/json

{
"detail": "Authentication credentials were not provided."
}

403