GET
/
onboardings
/
{onboardingId}
Get onboarding.
curl --request GET \
  --url https://sandbox.api.openfx.com/v1/onboardings/{onboardingId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Signature: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "id": "onb_01953e1a5f4b7800",
  "status": "completed",
  "entityId": "ent_01953e1a5f4b7100",
  "customerId": "cus_01953e1a5f4b7000",
  "relationshipIds": [
    "erel_01953e1a5f4b7101"
  ],
  "kybStatus": "approved",
  "createdAt": "2026-02-23T12:00:00Z",
  "updatedAt": "2026-02-23T13:00:00Z"
}

Authorizations

​
Authorization
string
header
required

API key issued at onboarding. Passed as a Bearer token in the Authorization header: Authorization: Bearer <api-key>. Identifies the caller and determines organization scope. Invalid or revoked keys return 401 with error type authentication_error.

​
X-Signature
string
header
required

Ed25519 or RSA-SHA256 asymmetric signature over the request payload (ADR-0015). Provides request integrity and non-repudiation. The signature covers the HTTP method, path, query string, request body, and timestamp. Invalid signatures return 401 with error type authentication_error.

​
X-Timestamp
string
header
required

Unix timestamp (seconds) of when the request was signed. Server rejects requests where the timestamp drifts beyond +/-60 seconds from server time to prevent replay attacks. Must match the timestamp used in the signature computation.

Path Parameters

​
onboardingId
string
required

Unique identifier of the onboarding (onb_ prefix). Onboarding resource identifier.

Pattern: ^onb_[A-Za-z0-9]+$
Example:

"onb_01953e1a5f4b7800"

Response

Onboarding details.

Orchestrated onboarding result. Wraps the entity, customer, and relationship creation into a single trackable resource. The onboarding progresses through pending → processing → completed (or failed).

​
id
string
required

Onboarding resource identifier.

Pattern: ^onb_[A-Za-z0-9]+$
Example:

"onb_01953e1a5f4b7800"

​
status
enum<string>
required

Status of an orchestrated onboarding request.

Available options:
pending,
processing,
completed,
failed
​
entityId
string
required

Entity resource identifier.

Pattern: ^ent_[A-Za-z0-9]+$
Example:

"ent_01953e1a5f4b7100"

​
customerId
string
required

Customer resource identifier.

Pattern: ^cus_[A-Za-z0-9]+$
Example:

"cus_01953e1a5f4b7000"

​
createdAt
string<date-time>
required

UTC timestamp in RFC 3339 / ISO 8601 format.

Example:

"2026-02-23T12:00:00Z"

​
relationshipIds
string[]

IDs of entity relationships created during onboarding (beneficial owners, directors, etc.).

Entity relationship resource identifier.

Pattern: ^erel_[A-Za-z0-9]+$
​
kybStatus
enum<string>

Know Your Business verification status.

Available options:
not_started,
pending,
approved,
rejected,
requires_info
​
updatedAt
string<date-time>

UTC timestamp in RFC 3339 / ISO 8601 format.

Example:

"2026-02-23T12:00:00Z"