Closings

After an offer is accepted, a closing takes the car from a deal to a pickup: the commission fee, the Bill of Sale, the funds, the gate pass, the title and the pickup. The API reads every closing your organization is a party to, so your systems and agents can see what is waiting, on whom, and by when. Since 1.5.0.

Neither is a default scope. Both an API key and a Connect Cypress token are accepted.

Read

curl "$BASE/api/v1/closings?status=IN_PROGRESS&yourTurn=true" -H "authorization: Bearer $TOKEN"
curl "$BASE/api/v1/closings/cls_…" -H "authorization: Bearer $TOKEN"

Each closing says which side you are on, SELLER for a car you sold and BUYER for one you bought, and lists its steps:

currentStep is the first open step that holds the closing up. requirements lists the documents the closing needs, what fills each, whether Cypress waived it, and whether it is satisfied.

What each side sees

• Signing links are your own side's. Each signature names its party and status; only your side's carry signingLink and email. An outside signer is emailed by Cypress's signing service and has neither.
• The commission is the seller's. The FEE step, and any requirement on it, is in the seller's view only.
• No money detail, and the other party by name only. No payment instructions, bank or lender accounts, invoices, amounts paid or references. price is the agreed price. counterparty names the other company (its side and its organization's name, as the closing page in the app shows it): it is your own trade, and the Bill of Sale names both. Never a person or a contact detail.
• Only your closings. Another company's closing answers 404, as one that does not exist.

Move a closing along

Three acts, none of which changes a step: they tell the people who must act. Each takes ?dryRun=true to see what would happen and an Idempotency-Key for safe retries, is recorded in your audit log with the key or app that did it, and can be repeated only after a while (a 409 carries retryAfter).

# Remind whoever's turn the Bill of Sale is
curl -X POST "$BASE/api/v1/closings/cls_…/steps/BOS/remind" -H "authorization: Bearer $TOKEN"

# Ask for a document a requirement still lacks
curl -X POST "$BASE/api/v1/closings/cls_…/document-requests" \
  -H "authorization: Bearer $TOKEN" -H "content-type: application/json" \
  -d '{ "requirementId": "req_…" }'

# Email a signer their signing link again
curl -X POST "$BASE/api/v1/closings/cls_…/documents/doc_…/signatures/buyer/resend" \
  -H "authorization: Bearer $TOKEN"

Mark your own steps

Your side's own steps can be marked done through the API. The same step action the app runs does the work, with the same checks, notifications and events:

curl -X POST "$BASE/api/v1/closings/cls_…/steps/GATE_PASS/actions" \
  -H "authorization: Bearer $TOKEN" -H "content-type: application/json" \
  -d '{ "action": "issue_gate_pass", "address": "1 Lot Rd", "city": "Austin", "state": "TX", "zip": "78701" }'

The answer is the step's and the closing's status afterwards. The other side's step is 403 POLICY_DENIED; a step that is not open yet, or a requirement still missing, is 409. Cypress's own actions, such as approving a Bill of Sale, are never offered.

Deadlines as events

Three events follow a closing while it waits on someone:

• Both sides hear them. Unlike the other CLOSING.* events, which go to the seller, these go to the seller and to the buyer, each in its own organization. The commission step's go to the seller only.
• They say whose turn it is. The body is the step as your side sees it:

{
  "closingId": "cls_…",
  "side": "BUYER",
  "vehicleId": "clx…",
  "step": {
    "key": "PICKUP", "number": 6, "label": "Vehicle pickup",
    "deadlineOwner": "CYPRESS", "turn": "BUYER", "yourTurn": true,
    "dueDate": "2026-10-16T09:00:00.000Z"
  }
}

• Once each. A step is told once per deadline; a deadline that moves is told again.
• Opt-in. Only a Cypress-dialect subscription that lists the event gets it, and subscribing needs closing:read. The envelope's href is /api/v1/closings/{id}.