Skip to main content

Get applicant short link

Returns the short URL that is normally texted to the applicant to complete their tasks.

Path Parameters
applicantId uuid — REQUIRED

The applicant ID

Header Parameters
X-CreditApp-Retailer-ID uuid
X-CreditApp-Creditor-ID uuid
Responses
200

The applicant's short link

Schema — OPTIONAL
shortLink string

The short URL that redirects to the applicant's customer portal.

link string

The full link that redirects to the applicant's customer portal.

401

Unauthorized

Schema — OPTIONAL
status integer — OPTIONAL
403

Access denied

Schema — OPTIONAL
status integer — OPTIONAL
message string — OPTIONAL
404

Applicant or short link not found

Schema — OPTIONAL
status integer — OPTIONAL
message string — OPTIONAL