Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get a Talent Adobe Onboarding Document

Retrieves the specified Adobe E-Sign document for a specified talent.

get/v1/talent/{talentId}/onboarding-documents/{documentId}

Path parameters

talentIdstring required

An identifier for the talent whose onboarding document is being retrieved.

documentIdstring required

An identifier for the Adobe E-Sign document that is being retrieved.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The requested Adobe E-Sign document for the specified talent.

documentIdinteger

The identifier for the onboarding document record.

talentIdinteger

The identifier for the talent.

documentNamestring

The file name of the document.

documentTypestring

The type of the document.

dateCreatedstring date-time

The date on which the onboarding document was sent to the talent. The field follows the YYYY-MM-DDTHH:mm:ss format and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01T14:30:00+00:00, and 2024-12-01T14:30:00.546+00:00.

createdByinteger

The BOLD ID of the user who sent the onboarding document to the talent.

verifiedByinteger

BOLD ID of the user that verified the onboarding document.

verifiedDatestring date-time

The date on which the onboarding document was verified. The field follows the YYYY-MM-DDTHH:mm:ss format and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01T14:30:00+00:00, and 2024-12-01T14:30:00.546+00:00.

documentContentsstring

The Base-64 encoded contents of the document.

isFailedLoadContentboolean

An indicator of whether the retreival of document contents from Adobe failed.

failedLoadContentErrorstring

The error that occurred while retrieving the document contents from Adobe.

Example response

{
  "documentId": 28925,
  "talentId": 138942,
  "documentName": "Federal W4.pdf",
  "documentType": "FederalW4",
  "createdBy": 62874,
  "verifiedBy": 62874,
  "isFailedLoadContent": true,
  "failedLoadContentError": "Document not found"
}