get
https://api.useoval.com/entity_onboarding
GET /entity_onboarding
Find onboardings for this organisation and environment. Results are ordered newest first. The reference filter is an exact, case-sensitive match.
Use a server-side bearer key for the same organisation and environment. See Authentication.
| Query parameter | Meaning |
|---|---|
page | One-based page number. Default 1. |
per_page | Page size from 1 to 100. Default 20. |
status | Filter by pending, action_required, processing, completed, or failed. |
reference | Exact, case-sensitive reference within the key’s scope. |
For the walkthrough, use GET /entity_onboarding?reference=applicant-0042&page=1&per_page=20. A search with no matches returns an empty data array. Use meta.total to determine whether there are more results.
Response · HTTP 200
{
"data": [
{
"id": "10000000-0000-4000-8000-000000000042",
"entity_type": "person",
"reference": "applicant-0042",
"status": "completed",
"status_reason": null,
"person_id": "30000000000040008000000000000042",
"created_at": "2026-11-01T12:00:00Z",
"updated_at": "2026-11-01T12:07:00Z",
"actions": []
}
],
"meta": {
"page": 1,
"per_page": 20,
"total": 1
}
}
Errors
| HTTP | What to check |
|---|---|
| 400 | Use page ≥ 1 and per_page from 1 to 100. |
| 401 | Invalid credentials or organisation access |
| 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