API reference
Hosted Application
Your application, run for you. Open the product
POST/v1/l/:tenant/applicationsKey
Submit a whole application: the same checks as the hosted pages, the answers sealed, the lender’s policy run for its staff, and the case put in its queue. Returns the reference and nothing about the outcome.
{start, contact: {email, mobile, emailToken?, mobileToken?}, about, statement: {csv} | {connection} | {later: true}, finances, consents: {key: true}, declaration: true}POST/v1/l/:tenant/bank-connectionsKey
Connect an applicant’s bank for your own application form. Send the applicant to url; they agree at their bank and come back to returnUrl with ?connection=<id>&status=ready|failed, and nothing personal. Their transactions are read by Creditcrest Statement exactly as on the hosted pages. Name the connection in the application, statement: {connection}: it is used once, before expiresAt, by whoever made it — you, with any of your own keys; with a sandbox key, that key alone. The connection is part of Statement and never charged on its own.
| Body | |
|---|---|
applicant | {firstName, lastName, email, mobile?}: email is needed, as the connection is made under it |
returnUrl | https:// on a public host name, where the applicant comes back to; any connection or status already in it is replaced. |
test | true for the provider’s own test bank, for a lender not yet live |
GET/v1/l/:tenant/bank-connections/:idKey
Where a bank connection stands: pending, ready, failed (with why, in words the applicant may be shown), used (with the application) or expired, and expiresAt, until when it can be finished or used. Once read, a summary: the accounts read, the transactions and the days they cover, and whether the account holder’s name matches the applicant’s — never a transaction. While ready, figures: what the hosted finances screen shows the applicant from their bank, each figure a month with what it is made of, for your form to ask whether they look right; and shownHash, to send back with the application. Read it before trusting the status in the return address.
POST/v1/l/:tenant/previewsKey
A preview link to the lender’s hosted pages: before it launches they say “Not open yet” to everybody else. Opened in a browser, the link lets that browser use the application, the account and support as an applicant would, until it expires. It names nobody, and anyone given it can use it, so give it only to the people testing the pages. The lender’s own key: a test key before launch, its live key once live. On the lender’s own domain, open /l/<lender>/preview/<token> there as well.
| Body | |
|---|---|
days | how long the link works: 1 to 30 days; 7 if left out |