Sign-By-Code Flow

Send Lease By Email

POST https://apis.sandbox.flexshopper.com/v3/leases/:id/send

This endpoint will render the lease as a PDF and send it to the customer via email.

Path Parameters

NameTypeDescription

id*

string

Lease ID.

Headers

NameTypeDescription

customer-token*

string

Customer's auth token returned by User Management endpoints.

Authorization*

string

API Auth key.

Sign By Code

POST https://apis.sandbox.flexshopper.com/v3/leases/:id/sign-by-code/:code

This endpoint will consume a code and confirm if that code is associated with this particular lease. If the code is correct, the lease is signed.

Path Parameters

NameTypeDescription

code*

string

The 5-7 character code found in the top right corner of the pdf emailed to the consumer.

id*

string

Lease ID.

Headers

NameTypeDescription

Authorization*

string

API Auth key.

customer-token*

string

Consumer's auth token returned by User Management endpoints.

Request Body

NameTypeDescription

signed*

boolean

The signed status of the lease (true: lease was signed, false: lease not signed).

timestamp

string

The date and time of the lease's signing

ipAddress*

string

The IP address of the device that was used to sign the lease

{
    data: {}
}

Last updated