Retrieving PDF reports | API

Created by Kevin Smith, Modified on Fri, 16 Aug, 2024 at 12:36 PM by Hannah Rowe


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

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule