applicants
get
/api/v1/applicants/{id}
One applicant from the directory.
- Scope
applicants:read- Rate limit
- 200 requests / min
- Idempotency
- read-only
Authentication
Send your key as Authorization: Bearer …. It must carry the scope applicants:read; a key without it receives 403 forbidden.
Path parameters
idstringrequiredRequest body
This operation takes no request body.
Response
200application/jsonSerializedApplicantidstringrequiredapl_… — stable for a given applicant email within your organization.
namestringrequiredtypestringrequiredindividual | business
emailstringrequiredphonestring | nullrequirednullablecredit_scorenumber | nullrequirednullableBureau score on the most recent case carrying a credit report; null when none.
total_applicationsnumberrequiredactive_loansnumberrequiredtotal_borrowednumberrequiredWhole dollars: the original principal of every loan made to this applicant, summed.
statusstringrequiredactive | inactive
last_activitystring | nullrequirednullabledate_addedstring | nullrequirednullableErrors
The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.
401unauthorized403forbidden404not_found429rate_limit_exceeded500internal_error