Brokers
Use the brokers endpoint to discover which identity and CPR providers are available for your client. The list is scoped to your API key — only brokers that are enabled for your account are returned.
Endpoint
List available brokers — GET /api/brokers
No request body or query parameters required. Authenticate with your X-Api-Key header as usual.
Response — array of broker objects:
| Field | Type | Description |
|---|---|---|
id |
string | Broker identifier used in all identity and CPR endpoint URLs (e.g. mitid, bankid_no) |
displayName |
string | Human-readable name |
enabled |
boolean | Whether this broker is active for your account |
requiresSeparateAgreement |
boolean | If true, you need a separate commercial agreement with this provider before use |
capabilities |
string | Comma-separated flags indicating supported operations: Identity, Cpr, or both |
Example response:
[
{
"id": "mitid",
"displayName": "MitID",
"enabled": true,
"requiresSeparateAgreement": false,
"capabilities": "Identity, Cpr"
},
{
"id": "bankid_no",
"displayName": "BankID Norway",
"enabled": true,
"requiresSeparateAgreement": true,
"capabilities": "Identity"
}
]
Capabilities
| Capability | Meaning |
|---|---|
Identity |
Broker supports identity verification flows (/api/auth/{brokerId}/start) |
Cpr |
Broker supports CPR lookup and validation (/api/cpr/{brokerId}/lookup) |
Before calling an identity or CPR endpoint, check the relevant capability to ensure the broker supports it. Using a broker that lacks the required capability returns 400 Bad Request.
Notes
- Always call this endpoint first during integration to discover which broker IDs to use.
- Broker availability is configured per account — your list may differ from another operator's.
- The
idvalue from this response is the{brokerId}path parameter used in identity and CPR endpoints.