> For the complete documentation index, see [llms.txt](https://developers.bloomcredit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bloomcredit.io/docs/v2.1/enablement-services/enablement_gql_ref.md).
# Enablement Services GraphQL API Reference
## Introduction
Welcome to the Bloom Enablement Services GraphQL API Reference.
Authorization is required to access the API. Some queries require organization level access, while others require user level access (after a user has been created). See the links below for more details.
In these docs, there are a lot of links that allow you to enumerate through the Enablement Services GraphQL API schema. If you aren't familiar with a type, click on it to see its fields and descriptions. Light mode (upper right corner of this page) may make links more evident.
### API Response Codes & Error Formats
**Standard GraphQL Responses**
* **Success and most errors:** All valid GraphQL requests return HTTP status code **200**. If an error occurs, the response includes an `errors` array and a `data` field (which may be `null`).
{
"errors": [
{
"message": "user is closed",
"path": ["openRentTradeline"],
"extensions": {
"code": "invalid"
}
}
],
"data": null
}
* **Internal errors and validation errors:** The enablement GraphQL API will return HTTP **422** (Unprocessable Entity) for invalid GraphQL requests or **500** (Internal Server Error) for unexpected errors, but will still follow the GraphQL error format:
{
"errors": [
{
"message": "internal error",
"extensions": {
"code": "internal"
}
}
],
"data": null
}
**Authentication Errors**
* **Current behavior:** Authentication failures (e.g., invalid session) return HTTP **401** with a non-GraphQL error format:
{
"error": {
"code": "unauthorized",
"message": "invalid session token"
}
}
* **Planned change:** In the future, authentication errors will also return HTTP **200** with a standard GraphQL error response (as above), for consistency.
**Possible error codes:**\
Here are current possible error codes to appear in extensions.code. The `extensions.code` field provides a machine-readable error type. The scenarios producing these codes vary between the many queries and mutations, and are detailed in the descriptions for each.
* `conflict` : The request could not be completed due to a conflict with the current state.
* `internal` : An internal server error occurred.
* `invalid` : The request is invalid (e.g., bad input, user is closed, etc.).
* `not_found` : The requested resource was not found.
* `not_implemented` : The requested operation is not implemented.
* `unauthorized` : The user is not authenticated or not authorized.
* `duplicate` : The resource already exists (duplicate entry).
{% code title="API Endpoints" %}
```
# Sandbox:
https://api.bloomplus.dev/v2/gql
# Production:
https://api.bloomplus.com/v2/gql
```
{% endcode %}
{% code title="Headers" %}
```
# See authorization guide for more details.
Authorization: Bearer
```
{% endcode %}
**Version**: 1.262.2
### Authorization
See [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md)
### Getting Started
New here? Check out the [Getting Started](/docs/v2.1/enablement-services/enablement-services-getting-started.md) guide.
### Last Updated
2026-04-15 21:17:03 UTC
## Queries
### me
Fetches the currently authenticated user's details.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ----------------------------- | ---------------------- |
| Internal business logic error | internal |
**Response**: Returns a [`User`](#definition-user)
{% tabs %}
{% tab title="Query" %}
```graphql
query Me {
me {
id
email
phoneNumber
name {
first
middle
last
}
address {
line1
line2
city
state
country
zipcode
type
}
status
notificationPreferences
createdAt
updatedAt
syncedAt
closedAt
connections {
edges {
...ConnectionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
tradelines {
edges {
...TradelinesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"me": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "buzz.inga@bloomcredit.io",
"phoneNumber": "+12345678901",
"name": {"first": "Buzz", "last": "Inga"},
"address": {
"line1": "123 Main St",
"city": "Athens",
"state": "FL",
"country": "USA",
"zipcode": "37745",
"type": "PRIMARY"
},
"status": "VERIFIED",
"notificationPreferences": "EMAIL",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-02T00:00:00Z",
"syncedAt": "10:15:30Z",
"closedAt": "10:15:30Z",
"connections": ConnectionsConnection,
"tradelines": TradelinesConnection
}
}
}
```
{% endtab %}
{% endtabs %}
### tradeline
The `tradeline` query allows you to retrieve a specific tradeline by `ID`.
> 🔒 Authentication: Requires organization or user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ------------------------------------- | ---------------------- |
| User not authenticated | unauthorized |
| Tradeline not found or not accessible | not\_found |
| Internal business logic error | internal |
**Response**: Returns a [`Tradeline`](#definition-tradeline)
**Arguments**
| Name | Description |
| ------------------------------ | --------------------------------------------------------- |
| `id` - [`ID!`](#definition-id) | The unique identifier for the tradeline you are querying. |
{% tabs %}
{% tab title="Query" %}
```graphql
query Tradeline($id: ID!) {
tradeline(id: $id) {
id
user {
id
email
phoneNumber
name {
...NameFragment
}
address {
...AddressFragment
}
status
notificationPreferences
createdAt
updatedAt
syncedAt
closedAt
connections {
...ConnectionsConnectionFragment
}
tradelines {
...TradelinesConnectionFragment
}
}
merchant
category
status
isEligible
paymentFrequency
lastTransactionDate
transactionCount
details {
... on RentTradelineDetails {
...RentTradelineDetailsFragment
}
... on UtilityTradelineDetails {
...UtilityTradelineDetailsFragment
}
... on TelcoTradelineDetails {
...TelcoTradelineDetailsFragment
}
}
createdAt
updatedAt
transactions {
edges {
...TransactionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
furnishments {
id
furnishedAt
}
financialAccount {
id
name
type
mask
institution {
...InstitutionFragment
}
connection {
...ConnectionFragment
}
}
reportedConsumerAccountNumber
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000"
}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"tradeline": {
"id": "00000000-0000-0000-0000-000000000000",
"user": User,
"merchant": "Pollen Water Co",
"category": "RENT",
"status": "UNOPENED",
"isEligible": true,
"paymentFrequency": "MONTHLY",
"lastTransactionDate": "2007-12-03",
"transactionCount": 123,
"details": RentTradelineDetails,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transactions": TransactionsConnection,
"furnishments": [Furnishment],
"financialAccount": FinancialAccount,
"reportedConsumerAccountNumber": "xyz789"
}
}
}
```
{% endtab %}
{% endtabs %}
### user
Fetches a user by their ID or email address.
> 🔒 Authentication: Requires organization scoped authorization. See the [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ----------------------------- | ---------------------- |
| Internal business logic error | internal |
| No identifier provided | invalid |
| Invalid ID format | invalid |
**Response**: Returns a [`User`](#definition-user)
**Arguments**
| Name | Description |
| ---------------------------------------- | ----------- |
| `id` - [`ID`](#definition-id) | |
| `email` - [`String`](#definition-string) | |
{% tabs %}
{% tab title="Query" %}
```graphql
query User(
$id: ID,
$email: String
) {
user(
id: $id,
email: $email
) {
id
email
phoneNumber
name {
first
middle
last
}
address {
line1
line2
city
state
country
zipcode
type
}
status
notificationPreferences
createdAt
updatedAt
syncedAt
closedAt
connections {
edges {
...ConnectionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
tradelines {
edges {
...TradelinesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"email": "xyz789"
}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "buzz.inga@bloomcredit.io",
"phoneNumber": "+12345678901",
"name": {"first": "Buzz", "last": "Inga"},
"address": {
"line1": "123 Main St",
"city": "Athens",
"state": "FL",
"country": "USA",
"zipcode": "37745",
"type": "PRIMARY"
},
"status": "VERIFIED",
"notificationPreferences": "EMAIL",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-02T00:00:00Z",
"syncedAt": "10:15:30Z",
"closedAt": "10:15:30Z",
"connections": ConnectionsConnection,
"tradelines": TradelinesConnection
}
}
}
```
{% endtab %}
{% endtabs %}
### userExistsWithEmail
Check if the user registering does not already exist in the database for your organization.
> 🔒 Requires Organization scoped authorization. See the [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ---------------------------------------- | ---------------------- |
| User not found (returns false, no error) | - |
| Internal business logic error | internal |
**Response**: Returns a [`Boolean!`](#definition-boolean)
**Arguments**
| Name | Description |
| ---------------------------------------------------- | ----------------------------------------------------------------- |
| `organizationSlug` - [`String!`](#definition-string) | Your organization's slug (url friendly name of your organization) |
| `email` - [`String!`](#definition-string) | User's email address |
{% tabs %}
{% tab title="Query" %}
```graphql
query UserExistsWithEmail(
$organizationSlug: String!,
$email: String!
) {
userExistsWithEmail(
organizationSlug: $organizationSlug,
email: $email
)
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"organizationSlug": "xyz789",
"email": "xyz789"
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"userExistsWithEmail": true}}
```
{% endtab %}
{% endtabs %}
### validateDateOfBirth
Validate user's stored date of birth with a passed in date of birth.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ---------------------------------------- | ---------------------- |
| User not found (returns false, no error) | - |
| Internal business logic error | internal |
**Response**: Returns a [`ValidateDateOfBirthOutput!`](#definition-validatedateofbirthoutput)
**Arguments**
| Name | Description |
| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `dateOfBirth` - [`DateInput!`](#definition-dateinput) | Birthdate to validate as user's recorded birthday. Must not be in the future, and can not be less than 18 years old. |
{% tabs %}
{% tab title="Query" %}
```graphql
query ValidateDateOfBirth($dateOfBirth: DateInput!) {
validateDateOfBirth(dateOfBirth: $dateOfBirth) {
isValid
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{"dateOfBirth": DateInput}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"validateDateOfBirth": {"isValid": true}}}
```
{% endtab %}
{% endtabs %}
### webhookDashboardUrl
The `webhookDashboardUrl` query allows you to get the URL for the webhook dashboard in order to view and manage webhooks.
> 🔒 Authentication: Requires organization scoped authorization via client credentials. See the 'Client Credentials Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ------------------------------------ | ---------------------- |
| User not authorized for organization | forbidden |
| Internal business logic error | internal |
**Response**: Returns a [`String!`](#definition-string)
{% tabs %}
{% tab title="Query" %}
```graphql
query WebhookDashboardUrl {
webhookDashboardUrl
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"webhookDashboardUrl": "xyz789"}}
```
{% endtab %}
{% endtabs %}
## Mutations
### closeTradeline
The `closeTradeline` mutation is used to confirm that a user has opted to stop having a recurring bill reported to the credit bureau(s). Upon successful execution, it returns the tradeline object.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| --------------------------------------------- | ---------------------- |
| Tradeline not found or not accessible by user | not\_found |
| Tradeline is not open | invalid |
| Internal business logic error | internal |
**Response**: Returns a [`CloseTradelineOutput!`](#definition-closetradelineoutput)
**Arguments**
| Name | Description |
| ------------------------------ | ---------------------------- |
| `id` - [`ID!`](#definition-id) | Unique tradeline identifier. |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation CloseTradeline($id: ID!) {
closeTradeline(id: $id) {
tradeline {
id
user {
...UserFragment
}
merchant
category
status
isEligible
paymentFrequency
lastTransactionDate
transactionCount
details {
... on RentTradelineDetails {
...RentTradelineDetailsFragment
}
... on UtilityTradelineDetails {
...UtilityTradelineDetailsFragment
}
... on TelcoTradelineDetails {
...TelcoTradelineDetailsFragment
}
}
createdAt
updatedAt
transactions {
...TransactionsConnectionFragment
}
furnishments {
...FurnishmentFragment
}
financialAccount {
...FinancialAccountFragment
}
reportedConsumerAccountNumber
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000"
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"closeTradeline": {"tradeline": Tradeline}}}
```
{% endtab %}
{% endtabs %}
### deleteConnection
The `deleteConnection` mutation soft deletes an aggregator connection from Bloom's system and emits the respective event to the aggregator. A webhook should be delivered once this asynchronous process completes.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
**Response**: Returns a [`DeleteConnectionOutput!`](#definition-deleteconnectionoutput)
**Arguments**
| Name | Description |
| ------------------------------ | ----------- |
| `id` - [`ID!`](#definition-id) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation DeleteConnection($id: ID!) {
deleteConnection(id: $id) {
connection {
id
status
institution {
...InstitutionFragment
}
financialAccounts {
...FinancialAccountFragment
}
user {
...UserFragment
}
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000"
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"deleteConnection": {"connection": Connection}}}
```
{% endtab %}
{% endtabs %}
### deleteMe
The `deleteMe` mutation is used to when a user wants to completely close their account and no longer have tradelines reported to credit bureaus. This mutation disconnects the aggregator from Bloom's Enablement Services.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ----------------------------- | ---------------------- |
| User not found | not\_found |
| Internal business logic error | internal |
**Response**: Returns a [`DeleteMeOutput!`](#definition-deletemeoutput)
{% tabs %}
{% tab title="Query" %}
```graphql
mutation DeleteMe {
deleteMe {
user {
id
email
phoneNumber
name {
...NameFragment
}
address {
...AddressFragment
}
status
notificationPreferences
createdAt
updatedAt
syncedAt
closedAt
connections {
...ConnectionsConnectionFragment
}
tradelines {
...TradelinesConnectionFragment
}
}
}
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"deleteMe": {"user": User}}}
```
{% endtab %}
{% endtabs %}
### deleteTradeline
The `deleteTradeline` mutation closes a tradeline due to fraud. This is a soft deletion, so it will be returned from the API as closed.
> 🔒 Authentication: Requires user scoped authorization via session token.
**Response**: Returns a [`DeleteTradelineOutput!`](#definition-deletetradelineoutput)
**Arguments**
| Name | Description |
| --------------------------------------------------------------------- | ----------------------------------- |
| `input` - [`DeleteTradelineInput!`](#definition-deletetradelineinput) | Identifies the tradeline to delete. |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation DeleteTradeline($input: DeleteTradelineInput!) {
deleteTradeline(input: $input) {
tradeline {
id
user {
...UserFragment
}
merchant
category
status
isEligible
paymentFrequency
lastTransactionDate
transactionCount
details {
... on RentTradelineDetails {
...RentTradelineDetailsFragment
}
... on UtilityTradelineDetails {
...UtilityTradelineDetailsFragment
}
... on TelcoTradelineDetails {
...TelcoTradelineDetailsFragment
}
}
createdAt
updatedAt
transactions {
...TransactionsConnectionFragment
}
furnishments {
...FurnishmentFragment
}
financialAccount {
...FinancialAccountFragment
}
reportedConsumerAccountNumber
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{"input": DeleteTradelineInput}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"deleteTradeline": {"tradeline": Tradeline}}}
```
{% endtab %}
{% endtabs %}
### importConnections
The `importConnections` mutation allows you to import multiple previously established aggregator connections, enabling our system to ingest and categorize transactions associated with those connections. This process facilitates transaction management and categorization for streamlined data handling within your application. Each connection can only be imported once. Only one of the `tokens` or `tokensWithMetadata` arrays should be provided. If the `tokens` array is provided, the `tokensWithMetadata` array will be ignored.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ------------------------------------------------------ | ---------------------- |
| Invalid or missing token(s) | invalid |
| One or more tokens already imported (duplicate entry) | conflict |
| Error parsing token(s) (malformed, not a valid string) | invalid |
| Internal business logic error | internal |
**Response**: Returns an [`ImportConnectionsOutput!`](#definition-importconnectionsoutput)
**Arguments**
| Name | Description |
| ------------------------------------------------------------------------- | ----------- |
| `input` - [`ImportConnectionsInput!`](#definition-importconnectionsinput) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation ImportConnections($input: ImportConnectionsInput!) {
importConnections(input: $input) {
connections {
id
status
institution {
...InstitutionFragment
}
financialAccounts {
...FinancialAccountFragment
}
user {
...UserFragment
}
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{"input": ImportConnectionsInput}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"importConnections": {"connections": [Connection]}
}
}
```
{% endtab %}
{% endtabs %}
### importPlaidProcessorTokens
Similar to `importConnections`, but each token is imported independently. Per-token failures are returned in `failures` and do not stop other tokens from being imported. Successful imports appear in `successes` (token plus connection).
**Response**: Returns an [`ImportPlaidProcessorTokensOutput!`](#definition-importplaidprocessortokensoutput)
**Arguments**
| Name | Description |
| ------------------------------------------------------------------------------------------- | ----------- |
| `input` - [`ImportPlaidProcessorTokensInput!`](#definition-importplaidprocessortokensinput) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation ImportPlaidProcessorTokens($input: ImportPlaidProcessorTokensInput!) {
importPlaidProcessorTokens(input: $input) {
successes {
token
connection {
...ConnectionFragment
}
}
failures {
token
error
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{"input": ImportPlaidProcessorTokensInput}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"importPlaidProcessorTokens": {
"successes": [ProcessorTokenImportSuccess],
"failures": [TokenError]
}
}
}
```
{% endtab %}
{% endtabs %}
### importUser
The importUser mutation is used to import an existing Bloom consumer into the Enablement Services platform. The consumer must have an email and phone number set.
> 🔒 Requires Organization scoped authorization. See the [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ----------------------------- | ---------------------- |
| Invalid consumer ID format | invalid |
| Consumer not found | not\_found |
| Internal business logic error | internal |
**Response**: Returns an [`ImportUserOutput!`](#definition-importuseroutput)
**Arguments**
| Name | Description |
| ----------------------------------------------------------- | ----------- |
| `input` - [`ImportUserInput!`](#definition-importuserinput) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation ImportUser($input: ImportUserInput!) {
importUser(input: $input) {
user {
id
email
phoneNumber
name {
...NameFragment
}
address {
...AddressFragment
}
status
notificationPreferences
createdAt
updatedAt
syncedAt
closedAt
connections {
...ConnectionsConnectionFragment
}
tradelines {
...TradelinesConnectionFragment
}
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{"input": ImportUserInput}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"importUser": {"user": User}}}
```
{% endtab %}
{% endtabs %}
### openRentTradeline
The `openRentTradeline` mutation is used to confirm that a user has opted to have a rent recurring bill reported to the credit bureau(s). Upon successful execution, it returns the tradeline that has been opened. This process ensures the tradeline is correctly configured for credit reporting.
This mutation is idempotent: if the tradeline is already open with the same details, it returns the existing tradeline without error. If the tradeline is already open with different details, it returns an error.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| --------------------------------------------- | ---------------------- |
| User is closed | invalid |
| Tradeline not found or not accessible by user | not\_found |
| Tradeline already open with different details | invalid |
| Tradeline status is not unopened | invalid |
| Tradeline is not eligible | invalid |
| Tradeline details missing | invalid |
| Tradeline details type is invalid | invalid |
| Tradeline is not a rent tradeline | invalid |
| Internal business logic error | internal |
Note: If tradeline is already open with the same details, the mutation succeeds and returns the existing tradeline (idempotent behavior).
**Response**: Returns an [`OpenRentTradelineOutput!`](#definition-openrenttradelineoutput)
**Arguments**
| Name | Description |
| ------------------------------------------------------------------- | ----------- |
| `id` - [`ID!`](#definition-id) | |
| `details` - [`RentTradelineInput!`](#definition-renttradelineinput) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation OpenRentTradeline(
$id: ID!,
$details: RentTradelineInput!
) {
openRentTradeline(
id: $id,
details: $details
) {
tradeline {
id
user {
...UserFragment
}
merchant
category
status
isEligible
paymentFrequency
lastTransactionDate
transactionCount
details {
... on RentTradelineDetails {
...RentTradelineDetailsFragment
}
... on UtilityTradelineDetails {
...UtilityTradelineDetailsFragment
}
... on TelcoTradelineDetails {
...TelcoTradelineDetailsFragment
}
}
createdAt
updatedAt
transactions {
...TransactionsConnectionFragment
}
furnishments {
...FurnishmentFragment
}
financialAccount {
...FinancialAccountFragment
}
reportedConsumerAccountNumber
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"details": RentTradelineInput
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"openRentTradeline": {"tradeline": Tradeline}}}
```
{% endtab %}
{% endtabs %}
### openTelcoTradeline
The `openTelcoTradeline` mutation is used to confirm that a user has opted to have a telco recurring bill reported to the credit bureau(s). Upon successful execution, it returns the tradeline that has been opened. This process ensures the tradeline is correctly configured for credit reporting.
This mutation is idempotent: if the tradeline is already open with the same details, it returns the existing tradeline without error. If the tradeline is already open with different details, it returns an error.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| --------------------------------------------- | ---------------------- |
| User is closed | invalid |
| Tradeline not found or not accessible by user | not\_found |
| Tradeline already open with different details | invalid |
| Tradeline status is not unopened | invalid |
| Tradeline is not eligible | invalid |
| Tradeline details missing | invalid |
| Tradeline details type is invalid | invalid |
| Tradeline is not a telco tradeline | invalid |
| Internal business logic error | internal |
Note: If tradeline is already open with the same details, the mutation succeeds and returns the existing tradeline (idempotent behavior).
**Response**: Returns an [`OpenTelcoTradelineOutput!`](#definition-opentelcotradelineoutput)
**Arguments**
| Name | Description |
| --------------------------------------------------------------------- | ----------- |
| `id` - [`ID!`](#definition-id) | |
| `details` - [`TelcoTradelineInput!`](#definition-telcotradelineinput) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation OpenTelcoTradeline(
$id: ID!,
$details: TelcoTradelineInput!
) {
openTelcoTradeline(
id: $id,
details: $details
) {
tradeline {
id
user {
...UserFragment
}
merchant
category
status
isEligible
paymentFrequency
lastTransactionDate
transactionCount
details {
... on RentTradelineDetails {
...RentTradelineDetailsFragment
}
... on UtilityTradelineDetails {
...UtilityTradelineDetailsFragment
}
... on TelcoTradelineDetails {
...TelcoTradelineDetailsFragment
}
}
createdAt
updatedAt
transactions {
...TransactionsConnectionFragment
}
furnishments {
...FurnishmentFragment
}
financialAccount {
...FinancialAccountFragment
}
reportedConsumerAccountNumber
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"details": TelcoTradelineInput
}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"openTelcoTradeline": {"tradeline": Tradeline}}}
```
{% endtab %}
{% endtabs %}
### openUtilityTradeline
The `openUtilityTradeline` mutation is used to confirm that a user has opted to have a utility recurring bill reported to the credit bureau(s). Upon successful execution, it returns the tradeline that has been opened. This process ensures the tradeline is correctly configured for credit reporting.
This mutation is idempotent: if the tradeline is already open with the same details, it returns the existing tradeline without error. If the tradeline is already open with different details, it returns an error.
> 🔒 Authentication: Requires user scoped authorization via session token. See the 'Session Token Authentication' section in [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| --------------------------------------------- | ---------------------- |
| User is closed | invalid |
| Tradeline not found or not accessible by user | not\_found |
| Tradeline already open with different details | invalid |
| Tradeline status is not unopened | invalid |
| Tradeline is not eligible | invalid |
| Tradeline details missing | invalid |
| Tradeline details type is invalid | invalid |
| Tradeline is not a utility tradeline | invalid |
| Internal business logic error | internal |
Note: If tradeline is already open with the same details, the mutation succeeds and returns the existing tradeline (idempotent behavior).
**Response**: Returns an [`OpenUtilityTradelineOutput!`](#definition-openutilitytradelineoutput)
**Arguments**
| Name | Description |
| ------------------------------------------------------------------------- | ----------- |
| `id` - [`ID!`](#definition-id) | |
| `details` - [`UtilityTradelineInput!`](#definition-utilitytradelineinput) | |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation OpenUtilityTradeline(
$id: ID!,
$details: UtilityTradelineInput!
) {
openUtilityTradeline(
id: $id,
details: $details
) {
tradeline {
id
user {
...UserFragment
}
merchant
category
status
isEligible
paymentFrequency
lastTransactionDate
transactionCount
details {
... on RentTradelineDetails {
...RentTradelineDetailsFragment
}
... on UtilityTradelineDetails {
...UtilityTradelineDetailsFragment
}
... on TelcoTradelineDetails {
...TelcoTradelineDetailsFragment
}
}
createdAt
updatedAt
transactions {
...TransactionsConnectionFragment
}
furnishments {
...FurnishmentFragment
}
financialAccount {
...FinancialAccountFragment
}
reportedConsumerAccountNumber
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"details": UtilityTradelineInput
}
```
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"openUtilityTradeline": {"tradeline": Tradeline}
}
}
```
{% endtab %}
{% endtabs %}
### registerOrganizationUser
The registerOrganizationUser mutation is used to create a new user in the database. Upon successful creation, the mutation will return the user's unique ID. You should store this ID in your database and associate it with your consumer record, as it will be required for accessing authenticated queries and mutations.
> 🔒 Requires Organization scoped authorization. See the [Enablement Services Authorization](/docs/v2.1/enablement-services/enablement-services-getting-started/enablement-services-authentication.md) guide for reference.
Business logic errors (all return HTTP status 200):
| Scenario | errors.extensions.code |
| ---------------------------------------------------- | ---------------------- |
| Input validation failed (invalid email, phone, etc.) | invalid |
| Phone number parsing/formatting failed | invalid |
| User already exists with the given email | invalid |
| Internal business logic error | internal |
**Response**: Returns a [`RegisterOrganizationUserOutput!`](#definition-registerorganizationuseroutput)
**Arguments**
| Name | Description |
| --------------------------------------------------------------------------------------- | ------------ |
| `input` - [`RegisterOrganizationUserInput!`](#definition-registerorganizationuserinput) | Input object |
{% tabs %}
{% tab title="Query" %}
```graphql
mutation RegisterOrganizationUser($input: RegisterOrganizationUserInput!) {
registerOrganizationUser(input: $input) {
user {
id
email
phoneNumber
name {
...NameFragment
}
address {
...AddressFragment
}
status
notificationPreferences
createdAt
updatedAt
syncedAt
closedAt
connections {
...ConnectionsConnectionFragment
}
tradelines {
...TradelinesConnectionFragment
}
}
}
}
```
{% endtab %}
{% tab title="Variables" %}
```json
{"input": RegisterOrganizationUserInput}
```
{% endtab %}
{% tab title="Response" %}
```json
{"data": {"registerOrganizationUser": {"user": User}}}
```
{% endtab %}
{% endtabs %}
## Types
### Address
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------- | ----------------------------------------------------------- |
| `line1` - [`String!`](#definition-string) | The first line of the address. |
| `line2` - [`String`](#definition-string) | The second line of the address (optional). |
| `city` - [`String!`](#definition-string) | The city of the address. |
| `state` - [`String!`](#definition-string) | The state or province of the address (2 letter state code). |
| `country` - [`String!`](#definition-string) | The country of the address. |
| `zipcode` - [`String!`](#definition-string) | The postal or ZIP code of the address (5 digit zipcode). |
| `type` - [`AddressType!`](#definition-addresstype) | The type of address. |
{% code title="Example" %}
```json
{
"line1": "123 Main St",
"line2": "Apt 101",
"city": "Athens",
"state": "FL",
"country": "USA",
"zipcode": "37745",
"type": "PRIMARY"
}
```
{% endcode %}
### AddressInput
*Input object*
The input for a user's address. Fields must not contain emojis.
**Fields**
| Input Field | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `line1` - [`String!`](#definition-string) | The first line of the address. Must be between 0 and 100 characters, not contain symbols or slashes, and have no leading spaces. |
| `line2` - [`String`](#definition-string) | The second line of the address (optional). Must not contain emojis. Must be between 0 and 100 characters, not contain symbols or slashes, and have no leading spaces. |
| `city` - [`String!`](#definition-string) | The city of the address. Can not contain numbers or special characters. Must be between 0 and 100 characters, not contain symbols or slashes, and have no leading spaces. |
| `state` - [`String!`](#definition-string) | The state or province of the address. Must be a valid 2 letter US state code. |
| `country` - [`String!`](#definition-string) | The country of the address. Must be between 0 and 100 characters, not contain symbols or slashes, and have no leading spaces. |
| `zipcode` - [`String!`](#definition-string) | The postal or ZIP code of the address. Must be a 5 digit number. |
| `type` - [`AddressType!`](#definition-addresstype) | The type of address. |
{% code title="Example" %}
```json
{
"line1": "123 Main St",
"line2": "Apt 101",
"city": "Athens",
"state": "FL",
"country": "USA",
"zipcode": "37745",
"type": "PRIMARY"
}
```
{% endcode %}
### AddressType
*Enum*
**Values**
| Enum Value | Description |
| ----------- | -------------------------------- |
| `PRIMARY` | The primary address of the user. |
| `SECONDARY` | A secondary address of the user. |
| `BUSINESS` | A business address of the user. |
| `MILITARY` | A military address of the user. |
{% code title="Example" %}
```graphql
"PRIMARY"
```
{% endcode %}
### Boolean
*Scalar*
The `Boolean` scalar type represents `true` or `false`.
### CloseTradelineOutput
*Object*
**Fields**
| Field Name | Description |
| --------------------------------------------------- | ------------------------------ |
| `tradeline` - [`Tradeline!`](#definition-tradeline) | The tradeline that was closed. |
{% code title="Example" %}
```json
{"tradeline": Tradeline}
```
{% endcode %}
### Connection
*Object*
**Fields**
| Field Name | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------- |
| `id` - [`ID!`](#definition-id) | The unique identifier for the connection. |
| `status` - [`ConnectionStatus!`](#definition-connectionstatus) | The current status of the connection. |
| `institution` - [`Institution!`](#definition-institution) | The financial institution associated with the connection. |
| `financialAccounts` - [`[FinancialAccount!]`](#definition-financialaccount) | The financial accounts associated with the connection. |
| `user` - [`User!`](#definition-user) | The user associated with the connection. |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"status": "ACTIVE",
"institution": Institution,
"financialAccounts": [FinancialAccount],
"user": User
}
```
{% endcode %}
### ConnectionFilter
*Input object*
**Fields**
| Input Field | Description |
| ------------------------------------------------------------- | ---------------------------- |
| `status` - [`ConnectionStatus`](#definition-connectionstatus) | Filter by connection status. |
{% code title="Example" %}
```json
{"status": "ACTIVE"}
```
{% endcode %}
### ConnectionStatus
*Enum*
**Values**
| Enum Value | Description |
| ------------------- | ---------------------------------------------------------------------------------- |
| `ACTIVE` | The connection is active and functioning as expected. |
| `REFRESH_REQUIRED` | The connection requires a refresh to retrieve updated data. |
| `CLOSED` | The connection has been closed by the user and is no longer active. |
| `DISCONNECTED` | There was a problem with the connection, and it needs to be refreshed or repaired. |
| `ERROR_SERVICE` | Unexpected error in gathering connections from aggregator |
| `ERROR_PROVIDER` | The connection provider is returning and error |
| `ERROR_INSTITUTION` | The connection provider is returning and error from the institution |
{% code title="Example" %}
```graphql
"ACTIVE"
```
{% endcode %}
### ConnectionsConnection
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------------------- | ------------------------------------------------------------- |
| `edges` - [`[ConnectionsEdge!]!`](#definition-connectionsedge) | An array of connection edges |
| `pageInfo` - [`PageInfo!`](#definition-pageinfo) | PageInfo provides information about the paginated collection. |
{% code title="Example" %}
```json
{
"edges": [ConnectionsEdge],
"pageInfo": PageInfo
}
```
{% endcode %}
### ConnectionsEdge
*Object*
The connections returned for a given user.
**Fields**
| Field Name | Description |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| `cursor` - [`String!`](#definition-string) | A unique identifier for a specific position in a paginated list. Used for fetching the next set of results in pagination. |
| `node` - [`Connection!`](#definition-connection) | The connection object. |
{% code title="Example" %}
```json
{
"cursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
"node": Connection
}
```
{% endcode %}
### ConnectionsInput
*Input object*
The input required to query the connections that exist for a given user.
**Fields**
| Input Field | Description |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `first` - [`Int`](#definition-int) | This is a pagination parameter. (I.e. get the first N records). |
| `after` - [`String`](#definition-string) | This is a pagination parameter. (I.e. get the first N records AFTER this cursor). |
| `filter` - [`ConnectionFilter`](#definition-connectionfilter) | Filter by connection status. |
{% code title="Example" %}
```json
{
"first": 5,
"after": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
"filter": ConnectionFilter
}
```
{% endcode %}
### CurrencyCode
*Enum*
**Values**
| Enum Value | Description |
| ---------- | -------------------------- |
| `USD` | The currency code for USD. |
{% code title="Example" %}
```graphql
"USD"
```
{% endcode %}
### Date
*Scalar*
A date in the format YYYY-MM-DD.
{% code title="Example" %}
```graphql
"2007-12-03"
```
{% endcode %}
### DateInput
*Input object*
**Fields**
| Input Field | Description |
| ----------------------------------- | ----------- |
| `day` - [`Int!`](#definition-int) | |
| `month` - [`Int!`](#definition-int) | |
| `year` - [`Int!`](#definition-int) | |
{% code title="Example" %}
```json
{"day": "14", "month": "6", "year": "1986"}
```
{% endcode %}
### DeleteConnectionOutput
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------------------------ | ------------------------------ |
| `connection` - [`Connection!`](#definition-connection) | The deleted connection object. |
{% code title="Example" %}
```json
{"connection": Connection}
```
{% endcode %}
### DeleteMeOutput
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------ | -------------------- |
| `user` - [`User!`](#definition-user) | Returned user object |
{% code title="Example" %}
```json
{"user": User}
```
{% endcode %}
### DeleteTradelineInput
*Input object*
Input for the deleteTradeline mutation (soft-delete due to fraud).
**Fields**
| Input Field | Description |
| --------------------------------------- | ---------------------------- |
| `tradelineId` - [`ID!`](#definition-id) | Unique tradeline identifier. |
{% code title="Example" %}
```json
{
"tradelineId": "00000000-0000-0000-0000-000000000000"
}
```
{% endcode %}
### DeleteTradelineOutput
*Object*
**Fields**
| Field Name | Description |
| --------------------------------------------------- | ---------------------------------------------- |
| `tradeline` - [`Tradeline!`](#definition-tradeline) | The tradeline that was deleted (soft-deleted). |
{% code title="Example" %}
```json
{"tradeline": Tradeline}
```
{% endcode %}
### FinancialAccount
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `id` - [`ID!`](#definition-id) | The unique identifier for the financial account. |
| `name` - [`String!`](#definition-string) | The name of the financial account. |
| `type` - [`FinancialAccountType!`](#definition-financialaccounttype) | The type of the financial account. |
| `mask` - [`String!`](#definition-string) | The mask of the financial account (usually the last 4 digits of the account number). |
| `institution` - [`Institution!`](#definition-institution) | The institution associated with the financial account. |
| `connection` - [`Connection`](#definition-connection) | The current connection for this financial account. |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "abc123",
"type": "DEPOSITORY",
"mask": "xyz789",
"institution": Institution,
"connection": Connection
}
```
{% endcode %}
### FinancialAccountType
*Enum*
**Values**
| Enum Value | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `DEPOSITORY` | Checking, Savings and cash management. |
| `INVESTMENT` | Brokerage, retirement and other investments. |
| `CREDIT` | Credit cards, and Lines of Credit. |
| `LOAN` | Mortgage, student and installment loans. |
| `UNKNOWN` | Reserved for historical records where the type can no longer be determined. This value is only used for financial accounts created before the type requirement was added and the type can no longer be retrieved from the external source. |
{% code title="Example" %}
```graphql
"DEPOSITORY"
```
{% endcode %}
### Furnishment
*Object*
The furnishment object.
**Fields**
| Field Name | Description |
| ------------------------------------------- | ------------------------------------------ |
| `id` - [`ID!`](#definition-id) | The unique identifier for the furnishment. |
| `furnishedAt` - [`Time!`](#definition-time) | The time the data was furnished. |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"furnishedAt": "10:15:30Z"
}
```
{% endcode %}
### ID
*Scalar*
The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
{% code title="Example" %}
```graphql
"00000000-0000-0000-0000-000000000000"
```
{% endcode %}
### ImportConnectionsInput
*Input object*
**Fields**
| Input Field | Description |
| ------------------------------------------------------------------------------------------------ | -------------------------------------------- |
| `tokens` - [`[String!]`](#definition-string) | The Plaid access tokens or Processor tokens. |
| `tokensWithMetadata` - [`[ProcessorTokenWithMetadata!]`](#definition-processortokenwithmetadata) | |
{% code title="Example" %}
```json
{
"tokens": ["abc123"],
"tokensWithMetadata": [ProcessorTokenWithMetadata]
}
```
{% endcode %}
### ImportConnectionsOutput
*Object*
**Fields**
| Field Name | Description |
| ---------------------------------------------------------- | ------------------------------- |
| `connections` - [`[Connection!]!`](#definition-connection) | The created connection objects. |
{% code title="Example" %}
```json
{"connections": [Connection]}
```
{% endcode %}
### ImportPlaidProcessorTokensInput
*Input object*
**Fields**
| Input Field | Description |
| ------------------------------------------------------------------------------------------------ | -------------------------------------------- |
| `tokens` - [`[String!]`](#definition-string) | The Plaid access tokens or Processor tokens. |
| `tokensWithMetadata` - [`[ProcessorTokenWithMetadata!]`](#definition-processortokenwithmetadata) | |
{% code title="Example" %}
```json
{
"tokens": ["abc123"],
"tokensWithMetadata": [ProcessorTokenWithMetadata]
}
```
{% endcode %}
### ImportPlaidProcessorTokensOutput
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------------------------------------------------------------ | ----------- |
| `successes` - [`[ProcessorTokenImportSuccess!]!`](#definition-processortokenimportsuccess) | |
| `failures` - [`[TokenError!]!`](#definition-tokenerror) | |
{% code title="Example" %}
```json
{
"successes": [ProcessorTokenImportSuccess],
"failures": [TokenError]
}
```
{% endcode %}
### ImportUserInput
*Input object*
**Fields**
| Input Field | Description |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` - [`String!`](#definition-string) | The ID of the consumer to import. This corresponds to the bloom consumer identifier used in [the core consumers endpoints](/reference/v2.1/core/consumers/retrieve-an-existing-consumer-using-the-generated-identifier.md) |
{% code title="Example" %}
```json
{"id": "00000000-0000-0000-0000-000000000000"}
```
{% endcode %}
### ImportUserOutput
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------ | ------------------------------------------------------------- |
| `user` - [`User!`](#definition-user) | The enablement user object created as a result of the import. |
{% code title="Example" %}
```json
{"user": User}
```
{% endcode %}
### Institution
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------------- | ------------------------------------------ |
| `name` - [`String!`](#definition-string) | The name of the financial institution. |
| `logoUrl` - [`String!`](#definition-string) | The logo URL of the financial institution. |
{% code title="Example" %}
```json
{"name": "bloom", "logoUrl": "https://example.com/logo.png"}
```
{% endcode %}
### Int
*Scalar*
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
{% code title="Example" %}
```json
987
```
{% endcode %}
### Money
*Object*
The money object.
**Fields**
| Field Name | Description |
| -------------------------------------------------------- | -------------------------- |
| `amount` - [`Int!`](#definition-int) | The amount of money. |
| `currency` - [`CurrencyCode!`](#definition-currencycode) | The currency of the money. |
{% code title="Example" %}
```json
{"amount": 987, "currency": "USD"}
```
{% endcode %}
### Name
*Object*
**Fields**
| Field Name | Description |
| ----------------------------------------- | ------------------------------------------------- |
| `first` - [`String!`](#definition-string) | A user's legal first name. |
| `middle` - [`String`](#definition-string) | A user's legal middle name or initial. (optional) |
| `last` - [`String!`](#definition-string) | A user's legal last name. |
{% code title="Example" %}
```json
{"first": "Buzz", "middle": "Z", "last": "Inga"}
```
{% endcode %}
### NameInput
*Input object*
**Fields**
| Input Field | Description |
| ----------------------------------------- | -------------------------------------- |
| `first` - [`String!`](#definition-string) | The users legal first name |
| `middle` - [`String`](#definition-string) | The users legal middle name (optional) |
| `last` - [`String!`](#definition-string) | The users legal last name |
{% code title="Example" %}
```json
{"first": "Buzz", "middle": "Z", "last": "Inga"}
```
{% endcode %}
### Node
*Interface*
**Fields**
| Field Name | Description |
| ------------------------------ | ----------------------------------- |
| `id` - [`ID!`](#definition-id) | The unique identifier for the node. |
**Possible Types**
| Node Types |
| -------------------------------------------------- |
| [`FinancialAccount`](#definition-financialaccount) |
| [`Connection`](#definition-connection) |
| [`Transaction`](#definition-transaction) |
| [`User`](#definition-user) |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000"
}
```
{% endcode %}
### NotificationType
*Enum*
**Values**
| Enum Value | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `EMAIL` | May be used in the future, but not at this time for enablement services customers. |
| `SMS` | May be used in the future, but not at this time for enablement services customers. |
| `NONE` | This should be the value used as we do not send notifications at this time to users tied to an enablement services customer. |
{% code title="Example" %}
```graphql
"EMAIL"
```
{% endcode %}
### OpenRentTradelineOutput
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------- | ------------------------------ |
| `tradeline` - [`Tradeline`](#definition-tradeline) | The tradeline that was opened. |
{% code title="Example" %}
```json
{"tradeline": Tradeline}
```
{% endcode %}
### OpenTelcoTradelineOutput
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------- | ------------------------------ |
| `tradeline` - [`Tradeline`](#definition-tradeline) | The tradeline that was opened. |
{% code title="Example" %}
```json
{"tradeline": Tradeline}
```
{% endcode %}
### OpenUtilityTradelineOutput
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------- | ------------------------------ |
| `tradeline` - [`Tradeline`](#definition-tradeline) | The tradeline that was opened. |
{% code title="Example" %}
```json
{"tradeline": Tradeline}
```
{% endcode %}
### PageInfo
*Object*
PageInfo provides information about the paginated collection.
**Fields**
| Field Name | Description |
| ------------------------------------------------- | ------------------------------------------- |
| `hasNextPage` - [`Boolean!`](#definition-boolean) | Indicates if there is a next page. |
| `endCursor` - [`String`](#definition-string) | The cursor for the end of the current page. |
{% code title="Example" %}
```json
{
"hasNextPage": true,
"endCursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
}
```
{% endcode %}
### PaymentFrequency
*Enum*
How often the tradeline is paid.
**Values**
| Enum Value | Description |
| ------------- | ----------------------------------- |
| `UNKNOWN` | The payment frequency is unknown. |
| `DAILY` | Payments are made daily. |
| `WEEKLY` | Payments are made weekly. |
| `BIWEEKLY` | Payments are made biweekly. |
| `SEMIMONTHLY` | Payments are made semimonthly. |
| `MONTHLY` | Payments are made monthly. |
| `BIMONTHLY` | Payments are made every two months. |
| `QUARTERLY` | Payments are made quarterly. |
| `SEMI_ANNUAL` | Payments are made semi-annually. |
| `ANNUAL` | Payments are made annually. |
{% code title="Example" %}
```graphql
"UNKNOWN"
```
{% endcode %}
### ProcessorTokenImportSuccess
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------------------------ | ----------- |
| `token` - [`String!`](#definition-string) | |
| `connection` - [`Connection!`](#definition-connection) | |
{% code title="Example" %}
```json
{
"token": "xyz789",
"connection": Connection
}
```
{% endcode %}
### ProcessorTokenWithMetadata
*Input object*
**Fields**
| Input Field | Description |
| ----------------------------------------------------------- | ----------- |
| `token` - [`String!`](#definition-string) | |
| `historicalSyncComplete` - [`Boolean`](#definition-boolean) | |
{% code title="Example" %}
```json
{
"token": "xyz789",
"historicalSyncComplete": false
}
```
{% endcode %}
### RegisterOrganizationUserInput
*Input object*
**Fields**
| Input Field | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `organizationSlug` - [`String!`](#definition-string) | URL-friendly name of the organization. |
| `email` - [`String!`](#definition-string) | The email address of the user. |
| `phoneNumber` - [`String!`](#definition-string) | The phone number of the user. Must be a US phone number. |
| `name` - [`NameInput!`](#definition-nameinput) | The name of the user. |
| `address` - [`AddressInput!`](#definition-addressinput) | The address of the user. |
| `dateOfBirth` - [`DateInput!`](#definition-dateinput) | The date of birth of the user. Must not be in the future, and can not be less than 18 years old. |
| `nationalId` - [`String`](#definition-string) | The national ID of the user (optional). |
| `visitorID` - [`String`](#definition-string) | The visitor ID for tracking purposes (optional). |
{% code title="Example" %}
```json
{
"organizationSlug": "bloom",
"email": "buzz.inga@bloomcredit.io",
"phoneNumber": "+12345678901",
"name": NameInput,
"address": AddressInput,
"dateOfBirth": DateInput,
"nationalId": "12345",
"visitorID": "12345"
}
```
{% endcode %}
### RegisterOrganizationUserOutput
*Object*
**Fields**
| Field Name | Description |
| ----------------------------------- | -------------------------------------------------------- |
| `user` - [`User`](#definition-user) | The user object created as a result of the registration. |
{% code title="Example" %}
```json
{"user": User}
```
{% endcode %}
### RentTradelineDetails
*Object*
The details associated with a rent tradeline.
**Fields**
| Field Name | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------- |
| `serviceAddressString` - [`String`](#definition-string) | Service address of the tradeline. |
| `serviceAddressType` - [`AddressType!`](#definition-addresstype) | Type of service address. |
| `leaseStartDate` - [`Date!`](#definition-date) | The start date of the lease. |
| `isPrimaryAddress` - [`Boolean!`](#definition-boolean) | Indicates if this is the primary address. |
| `hasOtherMortgageOrRent` - [`Boolean!`](#definition-boolean) | Indicates if there are other mortgage or rent obligations. |
{% code title="Example" %}
```json
{
"serviceAddressString": "xyz789",
"serviceAddressType": "PRIMARY",
"leaseStartDate": "2007-12-03",
"isPrimaryAddress": true,
"hasOtherMortgageOrRent": true
}
```
{% endcode %}
### RentTradelineInput
*Input object*
**Fields**
| Input Field | Description |
| --------------------------------------------------------------- | ---------------------------------------------------------- |
| `serviceAddressString` - [`String`](#definition-string) | The service address of the tradeline. |
| `serviceAddressType` - [`AddressType`](#definition-addresstype) | The type of service address. |
| `leaseStartDate` - [`Date`](#definition-date) | The start date of the lease. |
| `isPrimaryAddress` - [`Boolean!`](#definition-boolean) | Indicates if this is the primary address. |
| `hasOtherMortgageOrRent` - [`Boolean!`](#definition-boolean) | Indicates if there are other mortgage or rent obligations. |
{% code title="Example" %}
```json
{
"serviceAddressString": "abc123",
"serviceAddressType": "PRIMARY",
"leaseStartDate": "2007-12-03",
"isPrimaryAddress": false,
"hasOtherMortgageOrRent": false
}
```
{% endcode %}
### String
*Scalar*
The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
{% code title="Example" %}
```graphql
"abc123"
```
{% endcode %}
### TelcoTradelineDetails
*Object*
The details associated with a telco tradeline.
**Fields**
| Field Name | Description |
| ------------------------------------------------ | -------------------------------------- |
| `servicePhone` - [`String!`](#definition-string) | Service phone number of the tradeline. |
{% code title="Example" %}
```json
{"servicePhone": "xyz789"}
```
{% endcode %}
### TelcoTradelineInput
*Input object*
**Fields**
| Input Field | Description |
| ------------------------------------------------ | ------------------------------------------ |
| `servicePhone` - [`String!`](#definition-string) | The service phone number of the tradeline. |
{% code title="Example" %}
```json
{"servicePhone": "abc123"}
```
{% endcode %}
### Time
*Scalar*
An RFC3339 formatted timestamp.
{% code title="Example" %}
```graphql
"10:15:30Z"
```
{% endcode %}
### TokenError
*Object*
**Fields**
| Field Name | Description |
| ----------------------------------------- | ----------- |
| `token` - [`String!`](#definition-string) | |
| `error` - [`String!`](#definition-string) | |
{% code title="Example" %}
```json
{
"token": "abc123",
"error": "abc123"
}
```
{% endcode %}
### Tradeline
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` - [`ID!`](#definition-id) | The unique identifier for the tradeline. |
| `user` - [`User!`](#definition-user) | The user that owns the tradeline. |
| `merchant` - [`String!`](#definition-string) | The merchant associated with the tradeline. |
| `category` - [`TradelineCategory!`](#definition-tradelinecategory) | The category of the tradeline. |
| `status` - [`TradelineStatus!`](#definition-tradelinestatus) | The status of the tradeline. |
| `isEligible` - [`Boolean!`](#definition-boolean) | Whether or not the tradeline is eligible for reporting to the credit bureaus. A tradelines eligibility is not dependent on the tradeline status. A tradeline is eligible if the following conditions are met: The tradeline has a payment frequency of bi-weekly or less frequent. (NOT DAILY/WEEKLY) The tradeline is an eligible category. (RENT, UTILITY, TELCO, SUBSCRIPTION) The tradeline has a transaction within the last 90 days, and at least 3 transactions total. |
| `paymentFrequency` - [`PaymentFrequency!`](#definition-paymentfrequency) | The payment frequency of the tradeline. |
| `lastTransactionDate` - [`Date!`](#definition-date) | The last transaction date of the tradeline. |
| `transactionCount` - [`Int!`](#definition-int) | The number of transactions associated with the tradeline. |
| `details` - [`TradelineDetails`](#definition-tradelinedetails) | The details associated with the tradeline. |
| `createdAt` - [`Time!`](#definition-time) | The time the tradeline was created. |
| `updatedAt` - [`Time!`](#definition-time) | The time the tradeline was last updated. |
| `transactions` - [`TransactionsConnection!`](#definition-transactionsconnection) | The transactions associated with the tradeline. |
| Arguments `input` - [`TransactionsInput!`](#definition-transactionsinput) | |
| `furnishments` - [`[Furnishment]`](#definition-furnishment) | Furnishment data associated to the tradeline |
| `financialAccount` - [`FinancialAccount`](#definition-financialaccount) | The most recent financial account associated with this tradeline, if any. A tradeline may be linked to different financial accounts over time; this returns only the current one. |
| `reportedConsumerAccountNumber` - [`String`](#definition-string) | The account number reported to credit bureaus for this tradeline. |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"user": User,
"merchant": "Pollen Water Co",
"category": "RENT",
"status": "UNOPENED",
"isEligible": false,
"paymentFrequency": "MONTHLY",
"lastTransactionDate": "2007-12-03",
"transactionCount": 123,
"details": RentTradelineDetails,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transactions": TransactionsConnection,
"furnishments": [Furnishment],
"financialAccount": FinancialAccount,
"reportedConsumerAccountNumber": "xyz789"
}
```
{% endcode %}
### TradelineCategory
*Enum*
**Values**
| Enum Value | Description |
| -------------- | -------------------------------------------------- |
| `RENT` | A tradeline associated with rent payments. |
| `UTILITY` | A tradeline associated with utility payments. |
| `TELCO` | A tradeline associated with telco payments. |
| `SUBSCRIPTION` | A tradeline associated with subscription payments. |
| `OTHER` | A tradeline associated with other payments. |
{% code title="Example" %}
```graphql
"RENT"
```
{% endcode %}
### TradelineDetails
*Union*
The details associated with a tradeline. See individual types for more details.
**Types**
| Union Types |
| ---------------------------------------------------------------- |
| [`RentTradelineDetails`](#definition-renttradelinedetails) |
| [`UtilityTradelineDetails`](#definition-utilitytradelinedetails) |
| [`TelcoTradelineDetails`](#definition-telcotradelinedetails) |
{% code title="Example" %}
```graphql
RentTradelineDetails
```
{% endcode %}
### TradelineStatus
*Enum*
**Values**
| Enum Value | Description |
| ---------- | --------------------------------------------------- |
| `UNOPENED` | The tradeline has never been opened. |
| `OPEN` | The tradeline is currently open. |
| `CLOSED` | The tradeline has been closed. |
| `DELETED` | The tradeline has been deleted (e.g. due to fraud). |
{% code title="Example" %}
```graphql
"UNOPENED"
```
{% endcode %}
### TradelinesConnection
*Object*
**Fields**
| Field Name | Description |
| ------------------------------------------------------------ | --------------------------------------------------------- |
| `edges` - [`[TradelinesEdge!]!`](#definition-tradelinesedge) | The edges of the tradelines connection. |
| `pageInfo` - [`PageInfo!`](#definition-pageinfo) | The pagination information for the tradelines connection. |
{% code title="Example" %}
```json
{
"edges": [TradelinesEdge],
"pageInfo": PageInfo
}
```
{% endcode %}
### TradelinesEdge
*Object*
The tradelines returned for a given connection.
**Fields**
| Field Name | Description |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `cursor` - [`String!`](#definition-string) | A unique identifier for a specific position in a paginated list. Used for fetching the next set of results in pagination. |
| `node` - [`Tradeline!`](#definition-tradeline) | The tradeline object. |
{% code title="Example" %}
```json
{
"cursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
"node": Tradeline
}
```
{% endcode %}
### TradelinesInput
*Input object*
**Fields**
| Input Field | Description |
| ----------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `first` - [`Int`](#definition-int) | This is a pagination parameter. (I.e. get the first N records). |
| `after` - [`String`](#definition-string) | This is a pagination parameter. (I.e. get the first N records AFTER this cursor). |
| `status` - [`TradelineStatus`](#definition-tradelinestatus) | Filter by the status of the tradeline. |
| `isEligible` - [`Boolean`](#definition-boolean) | Filter by whether or not the tradeline is eligible for reporting to the credit bureaus. |
{% code title="Example" %}
```json
{"first": 5, "after": "3", "status": "UNOPENED", "isEligible": true}
```
{% endcode %}
### Transaction
*Object*
The transaction object.
**Fields**
| Field Name | Description |
| --------------------------------------------------- | ------------------------------------------------------ |
| `id` - [`ID!`](#definition-id) | The unique identifier for the transaction. |
| `date` - [`Date!`](#definition-date) | The date of the transaction. |
| `value` - [`Money!`](#definition-money) | The value of the transaction. |
| `tradeline` - [`Tradeline!`](#definition-tradeline) | The tradeline that the transaction is associated with. |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"date": "2007-12-03",
"value": Money,
"tradeline": Tradeline
}
```
{% endcode %}
### TransactionsConnection
*Object*
**Fields**
| Field Name | Description |
| -------------------------------------------------------------- | ----------------------------------------------------------- |
| `edges` - [`[TransactionsEdge]`](#definition-transactionsedge) | The edges of the transactions connection. |
| `pageInfo` - [`PageInfo!`](#definition-pageinfo) | The pagination information for the transactions connection. |
{% code title="Example" %}
```json
{
"edges": [TransactionsEdge],
"pageInfo": PageInfo
}
```
{% endcode %}
### TransactionsEdge
*Object*
The transactions returned for a given connection.
**Fields**
| Field Name | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `cursor` - [`String!`](#definition-string) | A unique identifier for a specific position in a paginated list. Used for fetching the next set of results in pagination. |
| `node` - [`Transaction!`](#definition-transaction) | The transaction object. |
{% code title="Example" %}
```json
{
"cursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
"node": Transaction
}
```
{% endcode %}
### TransactionsInput
*Input object*
**Fields**
| Input Field | Description |
| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `first` - [`Int`](#definition-int) | This is a pagination parameter. (I.e. get the first N records). - Optional. Only required if you are wanting to query for the transactionsas well. |
| `after` - [`String`](#definition-string) | This is a pagination parameter. (I.e. get the first N records AFTER this cursor). - Optional. Only required if you are wanting to query for the transactions as well. |
{% code title="Example" %}
```json
{"first": 5, "after": "3"}
```
{% endcode %}
### User
*Object*
The user type
**Fields**
| Field Name | Description |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` - [`ID!`](#definition-id) | Global identifier for the user. |
| `email` - [`String!`](#definition-string) | User's email address |
| `phoneNumber` - [`String!`](#definition-string) | User's phone number |
| `name` - [`Name!`](#definition-name) | User's name |
| `address` - [`Address!`](#definition-address) | User's address |
| `status` - [`UserStatus!`](#definition-userstatus) | User's status |
| `notificationPreferences` - [`NotificationType!`](#definition-notificationtype) | Notifications are currently not sent for enablement Services. |
| `createdAt` - [`Time!`](#definition-time) | The time the user was created in the database. |
| `updatedAt` - [`Time!`](#definition-time) | The last time the user was updated. |
| `syncedAt` - [`Time`](#definition-time) | The last time this user's connections were synced. |
| `closedAt` - [`Time`](#definition-time) | The time this user profile was closed. |
| `connections` - [`ConnectionsConnection!`](#definition-connectionsconnection) | The financial institution connections the user has created. |
| Arguments `input` - [`ConnectionsInput!`](#definition-connectionsinput) | |
| `tradelines` - [`TradelinesConnection!`](#definition-tradelinesconnection) | The tradelines associated with the connected financial institution(s) this user has connected. |
| Arguments `input` - [`TradelinesInput!`](#definition-tradelinesinput) | |
{% code title="Example" %}
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"email": "buzz.inga@bloomcredit.io",
"phoneNumber": "+12345678901",
"name": {"first": "Buzz", "last": "Inga"},
"address": {
"line1": "123 Main St",
"city": "Athens",
"state": "FL",
"country": "USA",
"zipcode": "37745",
"type": "PRIMARY"
},
"status": "VERIFIED",
"notificationPreferences": "EMAIL",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-02T00:00:00Z",
"syncedAt": "10:15:30Z",
"closedAt": "10:15:30Z",
"connections": ConnectionsConnection,
"tradelines": TradelinesConnection
}
```
{% endcode %}
### UserStatus
*Enum*
**Values**
| Enum Value | Description |
| ---------- | ----------------------------------------------------------------------------------------------- |
| `PENDING` | Pending is to be used prior to verifying the user - whether that be through OTP or other means. |
| `VERIFIED` | Use this status once the user has been verified. |
{% code title="Example" %}
```graphql
"PENDING"
```
{% endcode %}
### UtilityTradelineDetails
*Object*
The details associated with a utility tradeline.
**Fields**
| Field Name | Description |
| ---------------------------------------------------------------- | ------------------------------------------------ |
| `serviceAddressString` - [`String`](#definition-string) | Service address of the tradeline. |
| `serviceAddressType` - [`AddressType!`](#definition-addresstype) | Type of service address. |
| `isPrimaryAddress` - [`Boolean!`](#definition-boolean) | Indicates if this is the primary address. |
| `utilityTypes` - [`[UtilityType!]!`](#definition-utilitytype) | The utility types associated with the tradeline. |
{% code title="Example" %}
```json
{
"serviceAddressString": "abc123",
"serviceAddressType": "PRIMARY",
"isPrimaryAddress": false,
"utilityTypes": ["WATER"]
}
```
{% endcode %}
### UtilityTradelineInput
*Input object*
**Fields**
| Input Field | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `serviceAddressString` - [`String`](#definition-string) | The service address of the tradeline. |
| `serviceAddressType` - [`AddressType`](#definition-addresstype) | The type of service address. |
| `isPrimaryAddress` - [`Boolean!`](#definition-boolean) | Indicates if this is the primary address. |
| `utilityTypes` - [`[UtilityType!]!`](#definition-utilitytype) | The utility types associated with the tradeline. If the additional utility type is provided, another type must be included. |
{% code title="Example" %}
```json
{
"serviceAddressString": "xyz789",
"serviceAddressType": "PRIMARY",
"isPrimaryAddress": true,
"utilityTypes": ["WATER"]
}
```
{% endcode %}
### UtilityType
*Enum*
**Values**
| Enum Value | Description |
| ------------ | ------------------------------------------------------------------------------------------------- |
| `WATER` | A utility type for water services. |
| `ELECTRIC` | A utility type for electric services. |
| `GAS` | A utility type for gas services. |
| `ADDITIONAL` | An additional utility type. Must be accompanied by another type when opening a utility tradeline. |
{% code title="Example" %}
```graphql
"WATER"
```
{% endcode %}
### ValidateDateOfBirthOutput
*Object*
**Fields**
| Field Name | Description |
| --------------------------------------------- | -------------------------------------- |
| `isValid` - [`Boolean!`](#definition-boolean) | The result of the birthdate validation |
{% code title="Example" %}
```json
{"isValid": true}
```
{% endcode %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://developers.bloomcredit.io/docs/v2.1/enablement-services/enablement_gql_ref.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.