Register Document Credential

Register a credential Popp uses to fetch a candidate's protected documentUrl. Stored at the organization-group level behind your API key. Only one credential is allowed per organization group; if one already exists, this returns 409 (update it with PATCH or remove it first). The token is write-only: it is encrypted at rest and never returned. Popp sends it as the {headerTokenKey} header over HTTPS. Authenticated with your API key alone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The credential to register.

string
required

A label for the credential.

string
required

Header name Popp should send the token under, e.g. x-api-key or Authorization.

string
required

The API key value (max 4096 bytes). Encrypted at rest and never returned.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json