Sign Lease

Signs a lease agreement and makes prepayment if necessary

POST /v3/leases/{leaseId}/sign

Request

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name	Type	Required	Description
customer-token	string		Customer's authentication token
x-version-override	string		N/A

Path Parameters

The endpoint path expects parameters.

Name	Type	Required	Description
leaseId	string		Lease agreement identifier

Body

You must provide a JSON payload.

Name	Type	Required	Description
ipAddress	string		The IP address of the device that was used to sign the lease.
timestamp	string		The date and time of the lease's signing.
signed	boolean		The signed status of the lease. Should be true

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

200

{
    "data": {}
}

400

{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email [e-mail]",
        "data": {}
    }
}

402

{
    "error": {
        "statusCode": 402,
        "code": "PaymentRequired",
        "message": "User user must make a payment to access a requested resource",
        "data": {}
    }
}

404

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

410

{
    "error": {
        "statusCode": 410,
        "code": "LeaseExpired",
        "message": "The lease expired. Please create a new lease.",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name	Type	Required	Description
data	object		N/A