Get Lease By ID

Returns the details of a lease.

/v3/leases/{leaseId}

GET https://apis.sandbox.flexshopper.com/v3/leases/{leaseId}

Path Parameters

Name	Type	Description
leaseId	string	Lease agreement identifier

Headers

Name	Type	Description
Customer-Token	string	Customer's authentication token
Authorization	string	Authentication token

200 Cake successfully retrieved.

{
  "data": {
    "leaseId": "\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk...",
    "contract": "...base64 html contract",
    "leaseStatus": "signed"
  }
}

404 Could not find the lease

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

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the lease info

Key	Type	Description
leaseId	String	A unique identifier for the generated lease.
contract	String	The lease contract, expressed as base64-encoded HTML.
leaseStatus	String	The current status of this lease, one of "signed" or "unsigned".