To get started, please email
email@example.com for API credentials.
The fastest way to start is to use our Postman Collection with your credentials.
You can find the Postman collection here.
Simply open the collection in Postman, click the three ellipses on the right
hand side of the collection in the pane on the left, select "edit", then
"Authorization" and pick "Basic Auth" in the drop-down and enter your
credentials. Post transactions to
/transactions and see results!
By clicking the three ellipses in the middle pane and selecting "code", you can see code snippets for the request you're currently making.
Applicant Flow (SME Lending)
- For an
end_user_id, send 1 or more
- When finished sending transactions for
end_user_id, send a
PUT end_usersrequest with
"ready"to indicate that processing should begin.
- When we're done processing, we will notify you with a
webhook with topic
end_user.processedand the end user id.
- Send a
GET transactions?end_user_id=myenduserto get the processed transactions for that end user.
- Send a
GET end_users/statisticsrequest to get statistics for that end user.
The transactions and statistics you will receive for an end_user are globally
enriched across all
POST /transactions requests.
After all the steps for "Automated processing" above, if you want to request
manual review for an
- Send a
PUT /end_usersrequest with status
review_requestedin the request body to indicate that you want manual review.
- When we're done manually reviewing, we will notify you with a webhook with
end_user.reviewedand the end_user_id.
- Send the
GETrequests in steps 4 and 5 above.
What do I have to do to use this full flow?
- Provide us with a webhook URL we can call to notify you when async processing is done.
- Ensure that
reference_idare consistent across different batches over time for the same applicant.