Retrieving PDF reports | API

Modified on Fri, 16 Aug at 12:36 PM


Retrieving the full PDF export


The full PDF export (containing all details and checks relating to a Process) can be downloaded via the GET /processes/{processId}/pdf-export endpoint.


You will need the processId to call this endpoint - which will have been provided in the response when you created your Process.



Retrieving specific sections only in the PDF export


The POST/processes/{processId}/pdf-export endpoint can be used to download a PDF with only certain sections included.


The following parameters can be provided to specify which sections to include:


{

  "includeCoverPage": true,

  "includeOverviewPage": true,

  "includePersonalDetails": true,

  "includeIdentityChecks": true,

  "includeLiveness": true,

  "includeSanctionsAndPeps": true,

  "includeAddressAndMortalityChecks": true,

  "includeBankAccountChecks": true,

  "includeForms": true,

  "includeAmlChecks": true,

  "includeCappChecks": true,

  "includeEsignDocuments": true,

  "includeAffordability": true

}


For a full breakdown of the schema and Enums, please visit our Swagger page.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article