GuidesAPI Reference
API Reference

/order/{key}/agreement

Get the loan agreement document for an order.

Before the Order is CAPTURED a draft version of the agreement will be returned. This version may be displayed before the order is captured. It will be available both as HTML and PDF.

After the Order is CAPTURED a final signed version of the agreement will be returned. This final version will only be available as a PDF.

NOTE: When fetching the final PDF version of the agreement you may receive a 404 response until the document has been generated.

Path Params
string
required

The unique order key generated by Credit Key.

Headers
string
enum
required

Requests the loan agreement in the specified MIME type format.

Allowed:
Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
text/html
application/json