API

The DocID^® business API is documented through an interactive Swagger interface.

Open the interactive API reference

The machine-readable OpenAPI document is available at:

Use the OAuth 2.0 endpoints to authenticate a website visitor and retrieve approved identity information.

Use the business API for the management and application resources described in the OpenAPI document. Authentication requirements, request schemas, responses, and error codes are specified per operation in the interactive reference.

• Call privileged operations from trusted server-side code.
• Use credentials intended for the current environment.
• Validate every response and handle non-success status codes.
• Do not log authorization headers or sensitive response data.
• Use documented identifiers rather than inferring resource relationships.