Skip to content

Make your first API call

Use GET /v1/auth/me to confirm that your backend can reach Dockt and that its credential has the expected workspace scope.

Export the production base URL and an API key or M2M access token:

Terminal window
export DOCKT_API_BASE_URL='https://api.dockt.com'
export DOCKT_API_TOKEN='REPLACE_WITH_BEARER_TOKEN'

Send the request:

Terminal window
curl --fail-with-body --silent --show-error \
-H "Authorization: Bearer $DOCKT_API_TOKEN" \
"$DOCKT_API_BASE_URL/v1/auth/me" | jq

The response uses Dockt’s single-resource envelope:

{
"object": "single",
"data": {
"object": "auth_context",
"auth_type": "api_credential",
"api_credential_type": "api_key",
"principal_scope_type": "workspace",
"permissions": [
"assessments:read",
"assessments:write",
"documents:read",
"documents:create",
"decisions:read"
],
"active_scope": {
"object": "principal_scope",
"scope_type": "workspace",
"scope_id": "wsp_example",
"account_id": "acc_example",
"name": "Production",
"role": null,
"status": "active"
},
"available_scopes": [],
"actor": null,
"onboarding_required": false,
"updated_at": "2026-08-06T09:30:00Z"
}
}

The values in your response differ. Check these fields:

  • auth_type is api_credential.
  • principal_scope_type is workspace for verification workflows.
  • active_scope.scope_id is the workspace you intend to use.
  • permissions contains the operations your integration needs.

Dockt returns an x-request-id response header. Log it with your own request correlation ID, without logging secrets or documents. Include the Dockt request ID when you contact hello@dockt.com about a failed request.

Your connection is ready. Continue with Verify one document or Complete an assessment.