Skip to main content
POST
Get a client's verification certificate
Returns a link to the client’s Verification Certificate: a one-page PDF showing that the client is verified, and the result of each check. Use it to file the certificate automatically, for example to Google Drive. Your team’s full audit record stays in the app (Download Certificate).

What you get

  • 201 when this call issued a new certificate, 200 when the latest one is still current. Calling again is always safe.
  • download_url works for 10 minutes and needs no login: treat it like a password until it expires. Each call signs a fresh link.
  • filename is unique per certificate — use it to avoid filing the same certificate twice.

When it isn’t available

A reviewed PEP or adverse-media match does not stop the certificate: it reads Match found — reviewed by the firm. What the certificate contains is listed under Data minimisation. Use details.reason to decide when to retry. Don’t pass it on to the client: whether and how a client is told about their verification is your compliance team’s call.

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers in your Instant Compliance organisation. Format: ic_live_….

Path Parameters

id
string
required

Customer identifier. Accepts either Instant Compliance's UUID or your own external_id.

Response

An existing, still-current certificate.

certificate_id
string
required

Public certificate code.

Example:

"IC-7F3K-9QP2"

created
boolean
required

True when this call issued the certificate.

issued_at
string<date-time>
required
outcome
enum<string>
required
Available options:
VERIFIED
verification_url
string<uri>
required

Public page confirming the certificate is genuine.

download_url
string<uri>
required

Download link for the PDF. Expires after 10 minutes; anyone holding it can download until then.

download_url_expires_at
string<date-time>
required
filename
string
required

Suggested file name; unique per certificate.

Example:

"verification-certificate-jane-citizen-IC-7F3K-9QP2.pdf"

content_type
enum<string>
required
Available options:
application/pdf