API flow

The integration moves from lead creation through prequalification and result retrieval. Every subsequent operation uses the leadId returned when the lead is created.

1. Create the lead. Send phone, email, down payment, and term to obtain the leadId.
2. Complete the application. Save personal information, address, financial data, and vehicle details.
3. Validate the applicant. Send the PIN and request the offer.
4. Retrieve the result. Get the lead details and follow its status changes.

flowchart TB
  accTitle: Auto Financing integration flow
  accDescr: The flow starts by creating a lead, collects the application information, validates the applicant with a PIN, and ends with the offer and follow-up operations.

  create["1. Create lead"] --> personal["2. Personal information"]
  personal --> address["3. Address<br/><small>Postal code</small>"]
  personal --> financial
  personal -. "Optional" .-> vehicle["5. Vehicle<br/><small>Make, model, and price</small>"]
  address --> ready["Application complete"]
  financial["4. Financial information"] --> ready
  vehicle -.-> ready
  ready --> pin["6. Send PIN"] --> offer["7. Request offer"]
  offer --> consult["Retrieve lead"]
  offer --> update["Update contact"]

  classDef primary fill:#8adb00,stroke:#6da900,color:#132100,stroke-width:1.5px;
  classDef secondary fill:#dfffa8,stroke:#8adb00,color:#132100;
  classDef followup fill:#f4f7f2,stroke:#8b9687,color:#263124,stroke-dasharray:5 3;
  class create,personal,address,financial,pin,offer primary;
  class vehicle,ready secondary;
  class consult,update followup;

Lead milestones

Field	Meaning
isComplete: false	Information required to complete the application is still missing.
isComplete: true	Personal information, address, vehicle data, and PIN confirmation are complete.
isPq: false	The lead has not passed prequalification.
isPq: true	The lead passed prequalification.

Integration guide

Create a leadCreate the application and save personal information.

Complete the applicationAdd address, financial, and vehicle data.

PIN and offerValidate the applicant and request an offer.

Manage leadsUpdate contacts and retrieve applications.

CatalogsLook up postal codes and vehicle data.

ErrorsIdentify error responses by operation.