latestOpenAPI 3.0.32026-08-12367267.0 KB

cda4b2b11372

Export session

This endpoint allows you to export data related to a specific session as a downloadable PDF document. You can choose to include the full session details, screening results, and/or proof of address documents. At least one export option must be set to true.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • sessionId (string, required) - The unique identifier of the session.

One of the following parameters must be set to true for the operation to proceed:

  • exportSession (boolean, optional) – Indicates whether to export the full session data.
  • exportScreening (boolean, optional) – Specifies whether to include screening results in the export.
  • exportProofOfAddress (boolean, optional) - Determines whether to include proof of address documents in the export.
post/export-session-as-pdf

Request body

sessionIdstring
companyKeystring
exportSessionboolean
exportScreeningboolean
exportProofOfAddressboolean

Example request

{
  "sessionId": "example-session-id-12345",
  "companyKey": "your-company-secret-key",
  "exportSession": true,
  "exportScreening": false,
  "exportProofOfAddress": false
}

Response

Success

resultstring

Example response

{
  "result": "data:application/pdf;base64,ABCD"
}