v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Customers

Generate a screening certificate for a specific customer

Calling this endpoint will return a download URL to a screening certificate for a specific customer. When the response is 201, it means the screening certificate is generated successfully, and can be downloaded from the link returned. When the response is 200, it indicates that the data for the certificate is not yet available and you should try again shortly.

You need the "View customers" permission to use this endpoint.

post/v2/customers/{customer_identifier}/reports

Path parameters

customer_identifierstring uuid required

The unique identifier we provided when you created the customer.

Request body

report_type'SCREENING_REPORT' required

Response

The customer report is not ready, please try again later.