Create a Credentials Session (API Explorer)

Public beta APIsQualification checks (beta)
Previous API versionsAPI version 2022-08-01
Previous API versionsAPI version 2020-12-07
Previous API versionsAPI version 2019-10-15

Built with

POST/credentials/session

Headers

Accept"application/json"Required
application/json

Body Parameters

permissible_purposeenumRequired
targetobjectRequired
- first_namestringRequired>=1 character
- last_namestringRequired>=1 character
- social_security_numberstringRequired
typeenumRequired
use_caseenumRequired

View in API Reference

Request

$ curl -X POST https://api.truework-sandbox.com/credentials/session \
>      -H "Authorization: Bearer " \
>      -H "Accept: application/json" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "permissible_purpose": "child-support",
>   "type": "employment-income",
>   "use_case": "mortgage"
> }'

Response

$	curl -X POST https://api.truework-sandbox.com/credentials/session \
>	-H "Authorization: Bearer " \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"permissible_purpose": "child-support",
>	"type": "employment-income",
>	"use_case": "mortgage"
>	}'