https://gateway.creditbenchmark.com.
How it works
1
Register a key pair
Generate an ES256 public/private key pair on the machine that will call the API and send us the public key. We register it and send you your
OAuthClientId and KID. This is a one-time setup per machine and environment. See Key pair setup.2
Get a token
Sign a client assertion with your registered ES256 private key and exchange it at
POST /api/security/token for a short-lived bearer token. Request a new token when it expires. See Request an access token.3
Resolve entities (if needed)
If your source data uses company names rather than CB identifiers, call
POST /beta/text/match_external to resolve them. Keep the matched identifiers as CB_ID values for analytics calls.4
Check available fields
Call
GET /beta/metadata/columns to see which fields, data types, and entitlements are available before building requests.5
Query analytics
Start with
POST /beta/data/getdata for row-level output. Use the specific analytics endpoints for trends, breakdowns, rating changes, and distributions.6
Discover metadata
Use the metadata routes under
/beta/metadata/ for available columns, rating scales, industry and geography schemas, and effective dates.
