Skip to content

Partner Lead API

Responses

Code Description Schema Examples
200 Success. LeadSuccessResponse success
400 Bad request. Indicates either that some required parameter is missing or value of the parameter is invalid. ErrorResponse missing_required_parameter
state_not_supported
eligible_vehicle_not_found
403 Forbidden. Indicates the request was rejected because the client does not have access rights to the content. ErrorMessageResponse forbidden
500 Server error. Indicates that the server encountered an unexpected condition or an error that prevented it from fulfilling the request. ErrorResponse server_error

Response Example

Success

1
2
3
4
5
6
7
8
9
{
  "status": "success",
  "message": "Processed successfully.",
  "transaction_id": "e7e40788-949e-4f7a-901c-b28e1b50c10",
  "bridge_urls": {
    "consumer_bridge_url": "https://consumer.url?sub4=e7e40788-949e-4f7a-901c-b28e1b50c10&partner=novo&sub1=0196596a-e597-7782-89f7-481a9512fcfa",
    "agent_bridge_url": "https://agent.url/agent?transactionId=e7e40788-949e-4f7a-901c-b28e1b50c10"
  }
}

Bad request

Missing required parameter
1
2
3
4
5
{
  "status": "error",
  "message": "application.drivers[0].name.last_name is a required field",
  "error_code": "invalid_request"
}
State not supported
1
2
3
4
5
{
  "status": "error",
  "message": "The state is not supported for now",
  "error_code": "state_not_supported"
}
Eligible vehicle not found
1
2
3
4
5
{
  "status": "error",
  "message": "Eligible vehicle not found",
  "error_code": "eligible_vehicle_not_found"
}

Forbidden

1
2
3
{
  "message": "Forbidden"
}

Server error

1
2
3
4
5
{
  "status": "error",
  "message": "The request encountered a processing failure.",
  "error_code": "server_error"
}