Get or Create a Lead
POST/partner/pre-loan-request
Get or create a lead (Pre-Loan Request) by Identification (RUT).
banca.me looks for the customer's most recent lead in the partner entity of the origin, that
is not ARCHIVED_SUCCESS and had activity in the last 28 days. When there is one, it is
returned with 200; otherwise a new lead is created and returned with 201. Leads of that
partner entity without activity for 28 days are closed as ARCHIVED_FAIL.
When the customer already has an active loan with your partner (BNPL loans aside), the
response is 200 with step ARCHIVED_SUCCESS and the loan in product. When the customer already has a loan request in
progress, the response is 200 and url links to that loan request; if that loan request is
already signed, the response is 413 unless your partner has the placement module.
Which fields are returned depends on the step and on your modules:
| Field | Returned |
|---|---|
step, originLabel | Always |
url | Always, except on ARCHIVED_SUCCESS |
archivedComment | On ARCHIVED_FAIL |
product | On ARCHIVED_SUCCESS |
documents | Always, except on ARCHIVED_SUCCESS and while the customer has a loan request in progress |
preApproves | On READY_FOR_LOAN and ARCHIVED_FAIL, with the evaluation module |
areRiskParamsDataOk | On FILL_FORM, with the evaluation module |
riskParams | With the evaluation module, except on ARCHIVED_SUCCESS and while the customer has a signed loan request pending approval |
protestsAndDelinquencies, claveUnica, previredHistory, sbifHistory | With the evaluation module, when banca.me has the report, except on ARCHIVED_SUCCESS and while the customer has a loan request in progress |
Request
Responses
- 200
- 201
- 400
- 401
- 403
- 404
- 409
- 413
- 422
Successful operation - Returned an existing lead
Successful operation - Created a new lead
Invalid metadata.phone or metadata.email, or the token is not your partner's current
API token.
The Authorization header is missing, or the token is malformed or not signed by banca.me.
Your partner or the partner entity of the origin is inactive.
originLabel is missing or is not one of your origins and your partner has more than one
partner entity; or banca.me could not find the person's name and sex for a RUT it does
not know yet (send metadata.first_name, metadata.last_name and metadata.sex).
The RUT belongs to a company, not to a person.
The customer has a signed loan request pending approval and your partner does not have
the placement module. With the module, the response is 200 with a link to that loan
request.
rut is missing (ERR_MISSING_BASIC_V2_DATA) or has a wrong check digit
(ERR_INVALID_ID_NUMBER).