# Bloom Credit Documentation

> Bloom Credit's API for accessing credit data and reporting payment history to credit bureaus.

## Guides: Getting Started
- [Introduction to the API](https://developers.bloomcredit.io/docs/getting-started-1.md): This page will help you get started with Bloom Credit. You'll be up and running in a jiffy!
- [Environments Overview](https://developers.bloomcredit.io/docs/environments-1.md)

## Guides: Quick Start
- [Create Consumers](https://developers.bloomcredit.io/docs/create-your-first-consumer.md)
- [Furnish Accounts](https://developers.bloomcredit.io/docs/furnishing-an-account.md): This page will help you get started with Bloom's Furnishment API.
- [Order Credit Data](https://developers.bloomcredit.io/docs/ordering-credit-data.md): Retrieving Credit Data for Consumers from Bloom's Data Access API
- [From Onboarding to your first Credit Report](https://developers.bloomcredit.io/docs/onboarding-to-first-credit-report.md): Getting started with the Bloom API, from Authentication to Ordering and fetching a Credit Report.
- [Migration Guide](https://developers.bloomcredit.io/docs/migration-guide.md)

## Guides: Core Concepts
- [Organizations](https://developers.bloomcredit.io/docs/organizations.md)
- [Portfolios](https://developers.bloomcredit.io/docs/portfolios.md)
- [Consumers](https://developers.bloomcredit.io/docs/consumers-1.md)

## Guides: Data Access
- [Credit Data Concepts](https://developers.bloomcredit.io/docs/credit-reports.md)
  - [Attributes](https://developers.bloomcredit.io/docs/attributes.md)
  - [Indicators](https://developers.bloomcredit.io/docs/indicators.md)
  - [Model Scores](https://developers.bloomcredit.io/docs/model-scores.md)
- [Credit Data Orders](https://developers.bloomcredit.io/docs/status-codes.md): Order Credit Data for Consumers using Bloom's Data Access API
- [Querying Reports](https://developers.bloomcredit.io/docs/querying-reports.md)
- [Batch Ordering](https://developers.bloomcredit.io/docs/batch-ordering.md)

## Guides: Furnishment
- [Business Reporting](https://developers.bloomcredit.io/docs/business-accounts.md): Reporting business accounts to both consumer and business bureaus.
  - [Consumer Business Account Reporting](https://developers.bloomcredit.io/docs/consumer-business-account-reporting.md): For consumers with business credit products, reported to consumer bureaus.
  - [Commercial Account Reporting](https://developers.bloomcredit.io/docs/commercial-account-reporting.md): For businesses with credit products, reported to business bureaus.
- [Statement Data](https://developers.bloomcredit.io/docs/statements-1.md)
- [Consumer Events](https://developers.bloomcredit.io/docs/consumer-events.md)
- [Error Codes](https://developers.bloomcredit.io/docs/error-codes.md)

## Guides: Enablement Services
- [What is Enablement Services?](https://developers.bloomcredit.io/docs/what-is-enablement-services.md)
- [Getting Started](https://developers.bloomcredit.io/docs/enablement-services-getting-started.md)
  - [Enablement Services Authentication](https://developers.bloomcredit.io/docs/enablement-services-authentication.md)
  - [How to Attest Different Tradeline Categories](https://developers.bloomcredit.io/docs/attesting-to-tradelines-by-category.md)
  - [Importing Existing Consumers into Enablement Services](https://developers.bloomcredit.io/docs/importing-existing-consumers-into-enablement-services.md)
  - [Plaid Processor Tokens](https://developers.bloomcredit.io/docs/plaid-processor-tokens.md)
- [GraphQL API Reference](https://developers.bloomcredit.io/docs/graphql-api.md)
- [Enablement Webhooks](https://developers.bloomcredit.io/docs/enablement-webhooks.md)
- [Migrating to the Bloom Aggregator ](https://developers.bloomcredit.io/docs/migrating-to-the-bloom-aggregator-enablement-services.md): For faster initial processing times, try the Bloom Aggregator.
- [Delete Tradelines](https://developers.bloomcredit.io/docs/delete-tradelines.md)
- [Reopen a Closed User](https://developers.bloomcredit.io/docs/reopen-a-closed-user.md): Reopen a closed user with Bloom's Enablement Services.
- [Reopen a Closed Tradeline](https://developers.bloomcredit.io/docs/reopen-a-closed-tradeline.md): Reopen a tradeline that has been closed in Bloom's Enablement Services

## Guides: Consumer Permissioned Data
- [Bring Your Own Token](https://developers.bloomcredit.io/docs/bring-your-own-token.md): Enable easier enrollment for users by automatically linking their bank accounts.

## API Reference: Core
- [API Authentication](https://developers.bloomcredit.io/reference/authentication.md)
- [Get Consumers](https://developers.bloomcredit.io/reference/r0vul3yyl2nvcmuvy29uc3vtzxjz.md)
- [Creates a consumer](https://developers.bloomcredit.io/reference/createconsumerv2-1.md): Create a Consumer record to be used in either Data Access of Furnishment APIs. Consumer will be stored for further uses.
- [Deletes Consumer by ConsumerID](https://developers.bloomcredit.io/reference/deleteconsumerv2-1.md)
- [Retrieve an existing consumer using the generated identifier](https://developers.bloomcredit.io/reference/getconsumerv2-1.md)
- [Updates Consumer by ConsumerID](https://developers.bloomcredit.io/reference/updateconsumerv2-1.md): Changes the Consumer information already stored
- [Returns an organization](https://developers.bloomcredit.io/reference/coreget-organization-1.md): Fetch an organization and its portfolios by organization ID
- [Returns an organization's portfolio](https://developers.bloomcredit.io/reference/r0vul3yyl2nvcmuvb3jnyw5pemf0aw9ul3bvcnrmb2xpby86cg9ydgzvbglvx2lk.md)

## API Reference: Furnishment API
- [Get Accounts Paginated](https://developers.bloomcredit.io/reference/get_accounts_paginated_api_v1_accounts__get-1.md): Returns a paginated collection of furnished accounts for the authenticated organization. Results can be filtered by account ID, external account identifier, credit product ID, creation date range,…
- [Create Account](https://developers.bloomcredit.io/reference/create_account_api_v1_accounts__post-1.md): Creates a furnished account and associates it with a credit product and primary consumer. The account attributes must satisfy portfolio-specific Metro 2 reporting rules. Duplicate identifiers and…
- [Get Account](https://developers.bloomcredit.io/reference/get_account_api_v1_accounts__account_id__get-1.md): Returns the furnished account identified by `account_id`, including current reporting attributes and event-derived status.
- [Update Account](https://developers.bloomcredit.io/reference/update_account_api_v1_accounts__account_id__patch-1.md): Updates mutable reporting attributes on the furnished account identified by `account_id`. Omitted fields retain their current values. Concurrent stale-data conflicts are retried and may return `409`…
- [Create Account Event](https://developers.bloomcredit.io/reference/create_account_event_api_v1_accounts__account_id__events__post-1.md): This is the single endpoint that captures every account lifecycle event. Each event is individually optional, but at least one must be provided; a request with no events is rejected. Each event has…
- [Create Consumer Event](https://developers.bloomcredit.io/reference/create_consumer_event_api_v1_consumers__consumer_id__events__post-1.md): This endpoint is used to create various consumer events. All events are optional, but one, and only one, event must be provided. Within each event there are required attributes.  Supported events: -…
- [Get Statements](https://developers.bloomcredit.io/reference/get_statements_api_v1_statements__get-1.md): Retrieve a collection of statements by organization.
- [Create Statement](https://developers.bloomcredit.io/reference/create_statement_api_v1_statements__post-1.md): Create a new statement. Duplicate statements return `409`, missing accounts return `404`, and account-state restrictions return `400`.
- [Get Statements By Credit Product](https://developers.bloomcredit.io/reference/get_statements_by_credit_product_api_v1_statements_credit_product__credit_product_id__get-1.md): Retrieve a collection of statements by organization and credit product.
- [Get Statement](https://developers.bloomcredit.io/reference/get_statement_api_v1_statements__statement_id__get-1.md): Retrieve a statement by ID.
- [Update Statement](https://developers.bloomcredit.io/reference/update_statement_api_v1_statements__statement_id__patch-1.md): Updates mutable values on the furnished statement identified by `statement_id`. The resulting statement must still satisfy account and portfolio reporting rules.

## API Reference: Data Access
- [Get full credit report](https://developers.bloomcredit.io/reference/data-accessget-order-full-report.md): Retrieves the full (processed/normalized) credit report for a specific order
- [Get raw credit report](https://developers.bloomcredit.io/reference/data-accessget-order-raw-report.md): Retrieves the raw (original bureau format) credit report for a specific order
- [Returns the orders created](https://developers.bloomcredit.io/reference/data-accessget-orders-1.md)
- [Build a new order for ingestion](https://developers.bloomcredit.io/reference/data-accessnew-order-1.md)
- [Find and return order metadata](https://developers.bloomcredit.io/reference/data-accessget-order-1.md)
- [Find and return subscriptions](https://developers.bloomcredit.io/reference/data-accessget-subscriptions.md)
- [Build a new subscription](https://developers.bloomcredit.io/reference/data-accessnew-subscription-1.md)
- [Find and return subscription metadata](https://developers.bloomcredit.io/reference/data-accessget-subscription-1.md)
- [Get Subscription Consumers](https://developers.bloomcredit.io/reference/data-accessget-subscription-consumers-1.md)
- [Patch Subscription Consumers](https://developers.bloomcredit.io/reference/data-accesspatch-subscription-consumers-1.md)
- [GraphQL API](https://developers.bloomcredit.io/reference/data-accesspost-graphql.md): Will fetch credit data stored on Bloom's servers via the provided GQL query. Queries that read credit_data_order_by_pk and attribute fields together reference ORDER_ID (uuid!) and order_id (String!)…
- [Alerts](https://developers.bloomcredit.io/reference/alerts.md)
- [Credit Attributes](https://developers.bloomcredit.io/reference/attributes-1.md): `credit_attributes` - `queries`
- [Credit Data Orders](https://developers.bloomcredit.io/reference/credit-data-order-1.md): `credit_data_orders` - `object`
- [Indicators: MLA Status](https://developers.bloomcredit.io/reference/mla-status.md): `object`
- [Indicators: OFAC Statuses](https://developers.bloomcredit.io/reference/ofac-status.md): `ofac_statuses` - `object`
- [Models: Reasons](https://developers.bloomcredit.io/reference/reasons.md): `score_reasons` - `object`
- [Models: Scores](https://developers.bloomcredit.io/reference/score.md): `scores` - `object`
- [Tradelines](https://developers.bloomcredit.io/reference/tradelines.md): `tradelines` - `object`
- [Narrative Descriptions (Reject)](https://developers.bloomcredit.io/reference/narrative-descriptions-reject.md)

## API Reference: Internal Service Endpoints
- [Create Account Batch](https://developers.bloomcredit.io/reference/create_account_batch_api_v1_accounts_batch_post.md): Create accounts in a batch. Only supports consumer v2.
- [Create Statements Batch](https://developers.bloomcredit.io/reference/create_statements_batch_api_v1_statements_batch_post.md): Create statements in a batch.
- [Get Statements By Portfolio](https://developers.bloomcredit.io/reference/get_statements_by_portfolio_api_v1_statements_credit_product__portfolio_id__get.md): Retrieve a collection of statements by organization and portfolio.

## API Reference: KrakenD - API Gateway
- [/v1/cpds/graphql](https://developers.bloomcredit.io/reference/ue9tvc92ms9jcgrzl2dyyxbocww.md)
- [/v1/cpds/graphql/enroll](https://developers.bloomcredit.io/reference/ue9tvc92ms9jcgrzl2dyyxbocwwvzw5yb2xs.md)
- [/v1/cpds/graphql/relay](https://developers.bloomcredit.io/reference/ue9tvc92ms9jcgrzl2dyyxbocwwvcmvsyxk.md)
- [Get organization configuration by slug](https://developers.bloomcredit.io/reference/getorganizationbyslug.md)
- [Create Accounts In Batch](https://developers.bloomcredit.io/reference/create_account_batch_api_v1_accounts_batch_post-1.md): Creates up to 24 furnished accounts in a single request. Each account is validated and persisted independently, so the call returns `201` even when some accounts fail: successfully created accounts…
- [Create Statements In Batch](https://developers.bloomcredit.io/reference/create_statements_batch_api_v1_statements_batch_post-1.md): Creates up to 24 statements in a single request. Each statement is validated and persisted independently, so the call returns `201` even when some statements fail: successfully created statements are…
- [Send an OTP to a user](https://developers.bloomcredit.io/reference/sendotp.md)
- [Verify an OTP and login the user](https://developers.bloomcredit.io/reference/verifyotp.md)
- [Submit for consumer prefill data](https://developers.bloomcredit.io/reference/getconsumerprefill.md)
- [Submit an OTP for consumer prefill](https://developers.bloomcredit.io/reference/verifyconsumerprefillotp.md)
- [Submit user data for onboarding](https://developers.bloomcredit.io/reference/submituseronboarding.md)
- [Get profile data for the authenticated user](https://developers.bloomcredit.io/reference/getme.md)
- [Authenticate a user for enablement services](https://developers.bloomcredit.io/reference/authenticateuser.md)
- [Revoke credit-score consent and end the My Credit Score+ enrollment](https://developers.bloomcredit.io/reference/unenrollcreditscore.md)
- [Get the user's My Credit Score+ enrollment state and consent copy](https://developers.bloomcredit.io/reference/getcreditscoreenrollment.md)
- [Record consent and enroll the user with My Credit Score+](https://developers.bloomcredit.io/reference/enrollcreditscore.md)
- [Mint a single-use share link for the user's credit data](https://developers.bloomcredit.io/reference/mintcreditscoresharelink.md)
- [Create a one-time embed session for an external user](https://developers.bloomcredit.io/reference/createpartnerembedsession.md)
- [Consume embed session and establish browser session](https://developers.bloomcredit.io/reference/consumepartnerembedsession.md)

## API Reference: Consumer Permissioned Data
- [Create invite tokens in batch for BYOT flow](https://developers.bloomcredit.io/reference/createinvitetokensbatch.md): Creates multiple invite tokens for the Bring Your Own Token (BYOT) flow. Each token associates an email with a processor token. Maximum 100 tokens per request.
- [Append processor tokens to an existing invite](https://developers.bloomcredit.io/reference/appendprocessortokens.md): Adds processor tokens to an existing unused invite token for the given email. The invite token must exist and not be used or expired. Maximum 25 tokens per email.

## Recipes
- [Query Credit Data using R](https://developers.bloomcredit.io/recipes/query-credit-data-using-r.md)

## Pages
- [‎ ‎ ‎ Enablement Services GraphQL API Reference](https://developers.bloomcredit.io/page/enablement_gql_ref.md)

## Changelog
- [Release Notes | August 1 - 18, 2026](https://developers.bloomcredit.io/changelog/release-notes-june-24-2026.md)
- [Release Notes | April 1, 2026](https://developers.bloomcredit.io/changelog/release-notes-april-1-2026.md)
- [Release Notes | Mar 4, 2026](https://developers.bloomcredit.io/changelog/release-notes-mar-4-2026.md)
- [Release Notes | Nov 19, 2025](https://developers.bloomcredit.io/changelog/release-notes-nov-19-2025.md)
- [Release Notes | Oct 29, 2025](https://developers.bloomcredit.io/changelog/release-notes-oct-29-2025.md)
- [Release Notes | Oct 8, 2025](https://developers.bloomcredit.io/changelog/release-notes-oct-8-2025.md)
- [Release Notes | Sept 16, 2025](https://developers.bloomcredit.io/changelog/release-notes-sept-16-2025.md)
- [Release Notes | May 27, 2025](https://developers.bloomcredit.io/changelog/release-notes-may-27-2025.md)
- [Release Notes | April 15th, 2025](https://developers.bloomcredit.io/changelog/relese-notes-april-15th-2025.md)
- [Release Notes | April 1st, 2025](https://developers.bloomcredit.io/changelog/release-notes-april-1st-2025.md)