Read application status, step plan, and handoff state

Check an application's status, its steps, and the state of the merchant completion handoff.

Returns the step plan with which steps are complete, whether the application is ready for review and anything blocking it, the latest handoff's state, and a masked snapshot of the application data. The handoff link itself is never returned.

Authenticate with your agent onboarding API key. An application outside your book of business, or in another tenant, returns 404.

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

Merchant application identifier (UUID).

Responses

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