Skip to main content
GET
/
verification
/
status
/
{verificationSession}
Poll verification session status
curl --request GET \
  --url https://{host}/api/v1/verification/status/{verificationSession} \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>'
{
  "verification_id": "<string>",
  "user_id": 123,
  "provider": "<string>",
  "status": "<string>",
  "verified_at": "<string>",
  "expires_at": "<string>",
  "next_action": "<string>",
  "last_polled_at": "<string>",
  "onboarding": "<string>"
}

Authorizations

​
Authorization
string
header
required

Sanctum personal access token (access_tokens / partner API settings).

​
API-key
string
header
required

UUID API key stored for the partner user.

Path Parameters

​
verificationSession
string
required

Response

Current session state

Current state of a verification session; poll until status is no longer pending or the session ends in an error/declined state.

​
verification_id
string
required

Same ID as returned from POST …/verification/flows.

​
user_id
integer
required

Employee user id this session belongs to.

​
provider
string
required
​
status
string
required

pending while the user is in progress; terminal values when the flow has finished or failed. After approved, partner onboarding may still require other steps; check onboarding when present.

​
verified_at
string
required
​
expires_at
string
required
​
next_action
string
required

Hint for SPA or mobile clients (e.g. keep showing verification UI, or expect redirect to partner).

​
last_polled_at
string
required
​
onboarding
string
required