Credentials

List person credentials

Returns a paginated list of credentials for a specific person, or all credentials if no person_id is provided

GET /api/3/people/{person_id}/credentials

Authentication

This endpoint requires authentication:

OAuth 2.0 Recommended

Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.

Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Required Scopes:

account.person.readonly

Parameters

Path Parameters

person_id integer
Required

Person ID

Query Parameters

per_page integer
Optional

Number of results per page

Default: 500

page integer
Optional

Page number for pagination

Default: 1

skip_pagination boolean
Optional

Skip pagination and return all results

Responses

200

List of credentials retrieved successfully

Response Fields

id string required

Unique hashid identifier for the credential

eg. abc123xyz
credential_type_id integer required

ID of the credential type

eg. 5
label string required

Human-readable label for the credential type

eg. Card Number
person_id integer required

ID of the person this credential belongs to

eg. 12345
value string | null

Credential value (only present for value-assignable credential types like cards, PINs, etc. Not present for mobile credentials)

eg. 1234567890
status string | null

Status for mobile credentials (HID Mobile Access)

eg. active
url string | null

PassFlow credential URL (only for PassFlow credentials in invited state)

wallet_type string | null

Wallet type for PassFlow credentials that have been added to wallet

401

Unauthorized - Invalid or missing authentication

Response Fields

error string
eg. unauthorized
error_description string
eg. The access token is invalid
403

Forbidden - User does not have permission

Response Fields

error string
eg. forbidden
error_description string
eg. You are not authorized to access this resource
500

Internal Server Error

Response Fields

error string
eg. internal_server_error
error_description string
eg. An unexpected error occurred

Request

curl -X GET \
  "https://api.doorflow.com/api/3/people/{person_id}/credentials" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses

List of credentials retrieved successfully

[
  {
    "id": "abc123xyz",
    "credential_type_id": 5,
    "label": "Card Number",
    "person_id": 12345,
    "value": "1234567890",
    "status": "active",
    "url": "string",
    "wallet_type": "string"
  }
]