Credit Bureaus

Reference for the credit_bureaus resource. Requests follow the conventions in Requests and Responses; fields you receive and may write are filtered by your user's permissions, so responses can contain a subset of the fields below.

Operations

Operation	Request
List	`GET /{profile}/user/v4/credit_bureaus`
Fetch	`GET /{profile}/user/v4/credit_bureaus/{id}`

Not available as a standard REST operation for this resource: create, update, delete — such requests return 402 feature_not_enabled or 403 permission_denied.

How it works

credit_bureaus are the company's configured credit bureaus — the valid credit_bureau_id values for the customer credit check run and record actions. Read-only: bureaus are configured in SecurityTrax administration, not through the API. Bureau credentials are never exposed here.

curl "https://portal.securitytrax.com/acme/user/v4/credit_bureaus" \
  -H "Authorization: Bearer stx_acme_..."

Visible to any caller holding either Credit Reports permission (customer- or lead-side).

Bureau types

Each bureau row carries a credit_bureau_type_id. These ids come from a platform-wide lookup and are identical for every company:

`credit_bureau_type_id`	Bureau type	Notes
1	TransUnion
2	Equifax	`run` accepts an optional `pin`.
3	HART
4	ADT
6	TransUnion Canada
7	Brinks / Monitronics	`run` accepts optional `brinks_options`.
8	SEP (Security Equity Partners)	`run` requires `sep_options`.
9	Protection One
10	Safe
11	Manual Score Entry	Use with the `record` action only — `run` rejects it.

Use the type to decide which per-bureau options the run action needs, and to route manual scores: a type-11 bureau is only valid for record, every other type is only valid for run.

Fields

Fields are grouped by the permission that gates them. A group you may not view is absent from responses; a group you may not write is rejected with 422 when sent in a write.

Bureau

View: any of: Credit Run; Lead Credit Run.

Field	Type	Writable	Validation
`name`	string (nullable)	Read-only	max length 100
`credit_bureau_type_id`	integer (nullable)	Read-only	min 0
`status`	string (nullable)	Read-only	one of: `active`, `deleted`

Pagination

The list endpoint uses client-controlled offset pagination: ?page= (1-based) and ?per_page= (default 25, max 100). The response mirrors meta.pagination (page, per_page, total, last_page) and sends an RFC5988 Link header; follow rel="next" to walk pages. See Pagination.

Filters

The list endpoint accepts these query-param filters: credit_bureau_type_id. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../credit_bureaus?sort= orders the list by: id, name, credit_bureau_type_id. Prefix a field with - for descending; comma-separate for tie-breakers. An unsupported field returns 422. See Sorting collections.

Requests and Responses — envelope, errors, pagination, and rate limits.
Authentication — tokens and the Authorization header.