GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Create an applicant session

Make a request to this API to begin a new applicant session and obtain a session token you can use to update applicant info, upload documents, and submit the application for processing.

Query Params
string
enum
Defaults to unauthenticated_user
Allowed:
Body Params
string
string
string

Optional, can be provided later via PUT /session/application.

string

Optional, can be provided later via PUT /session/application.

string

Optional, can be provided later via PUT /session/application.

uuid

The applicant identifier that links this application to a previous application if it exists.

uuid | null

The id that relates to the universal user concept across all applications.

Responses

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json