Skip to main content
GET
Get a signed download URL for one onboarding document

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).

entityOnboardingId
integer<int32>
required

Entity onboarding ID from the documents list.

documentId
integer<int32>
required

Document ID from the documents list.

Response

OK

url
string | null
fileName
string | null
expiresAt
string<date-time>