get
https://api.useoval.com/entity_onboarding/
GET /entity_onboarding/{id}
Read the current state, resulting person ID and available actions using the organisation and environment that created the onboarding.
Use a server-side bearer key for the same organisation and environment. See Authentication.
Pass the saved onboarding ID in the path. Check each action’s status and expires_at before displaying its url. A completed or failed onboarding has an empty actions array.
| Status | What your integration should do |
|---|---|
pending | Save the onboarding ID. Fetch it again while Graph prepares the next step. |
action_required | Inspect actions. Present an available link to the applicant, or refresh an expired action. |
processing | Wait for Graph to finish verification and link the person. Use webhooks or poll the same ID. |
completed | Save person_id and use it for the next API request. |
failed | Stop polling. Read status_reason when present. This onboarding is terminal. |
Response · HTTP 200
{
"data": {
"id": "10000000-0000-4000-8000-000000000042",
"entity_type": "person",
"reference": "applicant-0042",
"status": "action_required",
"status_reason": null,
"person_id": null,
"created_at": "2026-11-01T12:00:00Z",
"updated_at": "2026-11-01T12:01:00Z",
"actions": [
{
"id": "20000000-0000-4000-8000-000000000042",
"type": "open_url",
"status": "available",
"url": "https://example.invalid/hosted/example",
"expires_at": "2026-11-01T12:30:00Z"
}
]
}
}
Errors
| HTTP | What to check |
|---|---|
| 401 | Invalid credentials or organisation access |
| 404 | Check the onboarding ID and the API key’s organisation and environment. |
| 500 | Graph could not process the request. Fetch the current state before retrying; reuse the same reference if the create result is uncertain. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Invalid credentials or organisation access