Skip to main content
GET
Get onboarding by key

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Path Parameters

key
string<uuid>
required

Onboarding job key (identifier).

Response

OK

onboardingKey
string<uuid>
onboardingID
integer<int32>
statusID
integer<int32> | null
statusName
string | null
createdOn
string<date-time> | null
sentOn
string<date-time> | null
submittedOn
string<date-time> | null
completedOn
string<date-time> | null
updatedOn
string<date-time> | null
createdByKey
string<uuid> | null
approverKey
string<uuid> | null
engagementKey
string<uuid> | null
formKey
string<uuid> | null
entities
object[] | null
recipients
object[] | null