Skip to main content

Submit an application to one or more creditors

Submit an application to one or more creditors

Path Parameters
applicationId string — REQUIRED
Header Parameters
X-CreditApp-Retailer-ID uuid
X-CreditApp-Creditor-ID uuid
Request Body
creditorIds string[] — REQUIRED

The creditor IDs. NOTE: creditor ids from the filter-results endpoint that have the isCreditorMapped set to false cannot be included in this list.

submittedBy string — REQUIRED

The retailer user ID of the user who submitted the application.

primaryApplicantId string — REQUIRED

The primary applicant ID.

coApplicantId string

The co-applicant ID.

acceptAntiSpamConsent boolean — REQUIRED

Indicates if the applicant(s) accepts the anti-spam consent.

creditConsent boolean — REQUIRED

Indicates if the applicant(s) accepts the credit consent.

privacyConsent boolean

Indicates if the applicant(s) grants privacy consent (Law 25 / Bill 64). Required for applicants residing in Quebec; defaults to false when omitted.

Responses
204

Submits a credit application to one or more creditors

400

Bad Request

Schema — OPTIONAL
status integer — OPTIONAL
message string — OPTIONAL
401

Unauthorized