Fetch Onboarding Application

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Onboarding Application represents an onboarding process related to a specific Application.

The Onboarding Application API exposes the status of the onboarding application and answers to onboarding questions.

Please see the includes query param to how to include onboarding question answers in the response.

📘

Onboarding Application's Onboarding Answer Documents

When an onboarding_application's onboarding_answer is a document due to the question requiring one, the response will be formatted as { filename: 'filename', url: 'url-to-document' }. The URL will allow you to download the document which will be the same document that was uploaded. If it was a PDF that was uploaded originally, a PDF will also be returned.


Path Params
string
required

ID of the resource

Query Params
include
array of strings
fields[onboarding_applications]
array of objects
fields[applications]
array of objects
fields[onboarding_answers]
array of objects
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json