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

Name	Type	Description
id*	string	Lease ID.

Headers

Name	Type	Description
customer-token*	string	Customer's auth token returned by User Management endpoints.
Authorization*	string	API Auth key.

204 Lease PDF generated and sent.

404 Lease with that id for that customer does not exist.

{
  "error": {
    "statusCode": 404,
    "code": "LeaseNotFound",
    "message": "The lease was not found.",
    "data": {}
  }
}

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

Name	Type	Description
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

Name	Type	Description
Authorization*	string	API Auth key.
customer-token*	string	Consumer's auth token returned by User Management endpoints.

Request Body

Name	Type	Description
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

200 Lease is found but status must be confirmed to verify that code was correct.

{
    data: {}
}

404 Lease id is not found for this consumer or code does not match.

{
  "error": {
    "statusCode": 404,
    "code": "LeaseCodeMismatch | LeaseNotFound",
    "message": "The code is incorrect for this lease. | The lease was not found",
    "data": {}
  }
}