For AI agents: visit https://developers.bloomcredit.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

All topics

# Bloom Enablement Services GraphQL API Reference

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`).

```json
{
    "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:

```json
{
    "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:

```json
{
    "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).

##### API Endpoints

```
# Sandbox:
https://api.bloomplus.dev/v2/gql
# Production:
https://api.bloomplus.com/v2/gql
```

##### Headers

```
# See authorization guide for more details.
Authorization: Bearer <USER_TOKEN>
```

##### Version

1.314.0

## Authorization

See [Enablement Services Authorization](https://developers.bloomcredit.io/docs/enablement-services-authentication)

## Getting Started

New here? Check out the [Getting Started](https://developers.bloomcredit.io/docs/enablement-services-getting-started) guide.

## Last Updated

2026-07-07 16:27:29 UTC

# Queries

## `me`

##### Description

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](https://developers.bloomcredit.io/docs/enablement-services-authentication#session-token-authentication) guide for reference.

Business logic errors (all return HTTP status 200):

| Scenario | errors.extensions.code |
| --- | --- |
| Internal business logic error | internal |

##### Response

Returns a [`User`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User)

#### Example

##### Query

```gql
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
      }
    }
  }
}
```

##### 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
    }
  }
}
```

[Queries](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Queries)

## `tradeline`

##### Description

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](https://developers.bloomcredit.io/docs/enablement-services-authentication#session-token-authentication) 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`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the tradeline you are querying. |

#### Example

##### Query

```gql
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
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000"
}
```

##### Response

```json
{
  "data": {
    "tradeline": {
      "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": 987,
      "details": RentTradelineDetails,
      "createdAt": "10:15:30Z",
      "updatedAt": "10:15:30Z",
      "transactions": TransactionsConnection,
      "furnishments": [Furnishment],
      "financialAccount": FinancialAccount,
      "reportedConsumerAccountNumber": "xyz789"
    }
  }
}
```

[Queries](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Queries)

## `user`

##### Description

Fetches a user by their ID or email address.

> 🔒 Authentication: Requires organization scoped authorization. See the [Enablement Services Authorization](https://developers.bloomcredit.io/docs/enablement-services-authentication) 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`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) |  |
| `email` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) |  |

#### Example

##### Query

```gql
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
      }
    }
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "email": "xyz789"
}
```

##### 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
    }
  }
}
```

[Queries](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Queries)

## `userExistsWithEmail`

##### Description

Check if the user registering does not already exist in the database for your organization.

> 🔒 Requires Organization scoped authorization. See the [Enablement Services Authorization](https://developers.bloomcredit.io/docs/enablement-services-authentication) 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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean)

##### Arguments

| Name | Description |
| --- | --- |
| `organizationSlug` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | Your organization's slug (url friendly name of your organization) |
| `email` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | User's email address |

#### Example

##### Query

```gql
query UserExistsWithEmail(
  $organizationSlug: String!,
  $email: String!
) {
  userExistsWithEmail(
    organizationSlug: $organizationSlug,
    email: $email
  )
}
```

##### Variables

```json
{
  "organizationSlug": "xyz789",
  "email": "xyz789"
}
```

##### Response

```json
{"data": {"userExistsWithEmail": false}}
```

[Queries](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Queries)

## `validateDateOfBirth`

##### Description

Validate user's stored date of birth with a passed in date of birth.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ValidateDateOfBirthOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `dateOfBirth` \- [`DateInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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. |

#### Example

##### Query

```gql
query ValidateDateOfBirth($dateOfBirth: DateInput!) {
  validateDateOfBirth(dateOfBirth: $dateOfBirth) {
    isValid
  }
}
```

##### Variables

```json
{"dateOfBirth": DateInput}
```

##### Response

```json
{"data": {"validateDateOfBirth": {"isValid": false}}}
```

[Queries](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Queries)

## `webhookDashboardUrl`

##### Description

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](https://developers.bloomcredit.io/docs/enablement-services-authentication#client-credentials-authentication) 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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String)

#### Example

##### Query

```gql
query WebhookDashboardUrl {
  webhookDashboardUrl
}
```

##### Response

```json
{"data": {"webhookDashboardUrl": "xyz789"}}
```

# Mutations

## `closeTradeline`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-CloseTradelineOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | Unique tradeline identifier. |

#### Example

##### Query

```gql
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
    }
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000"
}
```

##### Response

```json
{"data": {"closeTradeline": {"tradeline": Tradeline}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `deleteConnection`

##### Description

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.

##### Response

Returns a [`DeleteConnectionOutput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-DeleteConnectionOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) |  |

#### Example

##### Query

```gql
mutation DeleteConnection($id: ID!) {
  deleteConnection(id: $id) {
    connection {
      id
      status
      institution {
        ...InstitutionFragment
      }
      financialAccounts {
        ...FinancialAccountFragment
      }
      user {
        ...UserFragment
      }
    }
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000"
}
```

##### Response

```json
{"data": {"deleteConnection": {"connection": Connection}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `deleteMe`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-DeleteMeOutput)

#### Example

##### Query

```gql
mutation DeleteMe {
  deleteMe {
    user {
      id
      email
      phoneNumber
      name {
        ...NameFragment
      }
      address {
        ...AddressFragment
      }
      status
      notificationPreferences
      createdAt
      updatedAt
      syncedAt
      closedAt
      connections {
        ...ConnectionsConnectionFragment
      }
      tradelines {
        ...TradelinesConnectionFragment
      }
    }
  }
}
```

##### Response

```json
{"data": {"deleteMe": {"user": User}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `deleteTradeline`

##### Description

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-DeleteTradelineOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`DeleteTradelineInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-DeleteTradelineInput) | Identifies the tradeline to delete. |

#### Example

##### Query

```gql
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
    }
  }
}
```

##### Variables

```json
{"input": DeleteTradelineInput}
```

##### Response

```json
{"data": {"deleteTradeline": {"tradeline": Tradeline}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `importConnections`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ImportConnectionsOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`ImportConnectionsInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ImportConnectionsInput) |  |

#### Example

##### Query

```gql
mutation ImportConnections($input: ImportConnectionsInput!) {
  importConnections(input: $input) {
    connections {
      id
      status
      institution {
        ...InstitutionFragment
      }
      financialAccounts {
        ...FinancialAccountFragment
      }
      user {
        ...UserFragment
      }
    }
  }
}
```

##### Variables

```json
{"input": ImportConnectionsInput}
```

##### Response

```json
{
  "data": {
    "importConnections": {"connections": [Connection]}
  }
}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `importPlaidProcessorTokens`

##### Description

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).

**Mutation-level errors** (GraphQL `errors` array; HTTP status 200; each error includes `extensions.code`):

| Scenario | errors.extensions.code |
| --- | --- |
| No non-empty tokens: both `tokens` and `tokensWithMetadata` missing, empty, or only empty strings after trimming | invalid |

**Per-token failures** (mutation returns `data` with HTTP 200; no GraphQL `errors` entry for these—inspect `failures`): Each `TokenError` has `token` and `error` (message only; no `extensions` on the response for these rows). The **error class** below matches the same `errors.extensions.code` taxonomy used elsewhere, for logging and client-side grouping:

| Scenario | error class |
| --- | --- |
| User is closed | invalid |
| Organization does not support Plaid processor token import | invalid |
| Connection not eligible for this organization | invalid |
| Duplicate connection / token already imported | conflict |
| Invalid or malformed token, aggregator validation failure | invalid |
| Internal or upstream failure | internal |

##### Response

Returns an [`ImportPlaidProcessorTokensOutput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ImportPlaidProcessorTokensOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`ImportPlaidProcessorTokensInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ImportPlaidProcessorTokensInput) |  |

#### Example

##### Query

```gql
mutation ImportPlaidProcessorTokens($input: ImportPlaidProcessorTokensInput!) {
  importPlaidProcessorTokens(input: $input) {
    successes {
      token
      connection {
        ...ConnectionFragment
      }
    }
    failures {
      token
      error
    }
  }
}
```

##### Variables

```json
{"input": ImportPlaidProcessorTokensInput}
```

##### Response

```json
{
  "data": {
    "importPlaidProcessorTokens": {
      "successes": [ProcessorTokenImportSuccess],
      "failures": [TokenError]
    }
  }
}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `importUser`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ImportUserOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`ImportUserInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ImportUserInput) |  |

#### Example

##### Query

```gql
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
      }
    }
  }
}
```

##### Variables

```json
{"input": ImportUserInput}
```

##### Response

```json
{"data": {"importUser": {"user": User}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `openRentTradeline`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-OpenRentTradelineOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) |  |
| `details` \- [`RentTradelineInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-RentTradelineInput) |  |

#### Example

##### Query

```gql
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
    }
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "details": RentTradelineInput
}
```

##### Response

```json
{"data": {"openRentTradeline": {"tradeline": Tradeline}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `openTelcoTradeline`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-OpenTelcoTradelineOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) |  |
| `details` \- [`TelcoTradelineInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TelcoTradelineInput) |  |

#### Example

##### Query

```gql
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
    }
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "details": TelcoTradelineInput
}
```

##### Response

```json
{"data": {"openTelcoTradeline": {"tradeline": Tradeline}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `openUtilityTradeline`

##### Description

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.

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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-OpenUtilityTradelineOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) |  |
| `details` \- [`UtilityTradelineInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-UtilityTradelineInput) |  |

#### Example

##### Query

```gql
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
    }
  }
}
```

##### Variables

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "details": UtilityTradelineInput
}
```

##### Response

```json
{
  "data": {
    "openUtilityTradeline": {"tradeline": Tradeline}
  }
}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `reOpenOrganizationUser`

##### Description

The reOpenOrganizationUser mutation reopens a previously closed user, clearing its `closedAt` timestamp. The user must currently be closed and belong to the authenticated organization. Upon success it returns the user object. After reopening, the client may re-establish bank connections via `importConnection` or `importPlaidProcessorTokens`.

Business logic errors (all return HTTP status 200):

| Scenario | errors.extensions.code |
| --- | --- |
| Invalid input format (malformed userId) | invalid |
| User not found in the organization | not\_found |
| User is not closed | invalid |
| Internal business logic error | internal |

##### Response

Returns a [`ReOpenOrganizationUserOutput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ReOpenOrganizationUserOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`ReOpenOrganizationUserInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ReOpenOrganizationUserInput) | Input object |

#### Example

##### Query

```gql
mutation ReOpenOrganizationUser($input: ReOpenOrganizationUserInput!) {
  reOpenOrganizationUser(input: $input) {
    user {
      id
      email
      phoneNumber
      name {
        ...NameFragment
      }
      address {
        ...AddressFragment
      }
      status
      notificationPreferences
      createdAt
      updatedAt
      syncedAt
      closedAt
      connections {
        ...ConnectionsConnectionFragment
      }
      tradelines {
        ...TradelinesConnectionFragment
      }
    }
  }
}
```

##### Variables

```json
{"input": ReOpenOrganizationUserInput}
```

##### Response

```json
{"data": {"reOpenOrganizationUser": {"user": User}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `registerOrganizationUser`

##### Description

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.

**Sandbox org size limit:** In the sandbox environment, registration is rejected if the organization already has **50 non-closed users** (users without a `closedAt` timestamp). Close existing users to add more. This does not apply to production.

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 |
| Organization at sandbox open-user limit (see above) | invalid |
| Internal business logic error | internal |

##### Response

Returns a [`RegisterOrganizationUserOutput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-RegisterOrganizationUserOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`RegisterOrganizationUserInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-RegisterOrganizationUserInput) | Input object |

#### Example

##### Query

```gql
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
      }
    }
  }
}
```

##### Variables

```json
{"input": RegisterOrganizationUserInput}
```

##### Response

```json
{"data": {"registerOrganizationUser": {"user": User}}}
```

[Mutations](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Operations-Mutations)

## `reopenTradeline`

##### Description

The `reopenTradeline` mutation reopens a tradeline that was previously closed by the consumer. The user must be open (not closed) and have at least one connection that is not closed and not disconnected. Upon success it returns the reopened tradeline object. Reopening then continues asynchronously; a `tradeline.reopened` webhook is delivered once this asynchronous process completes.

Business logic errors (all return HTTP status 200):

| Scenario | errors.extensions.code |
| --- | --- |
| Invalid input format (malformed tradelineId) | invalid |
| Tradeline not found or not accessible by user | not\_found |
| User is closed | invalid |
| User has no connection that is open (not closed/disconnected) | invalid |
| Tradeline is not closed, or was not closed by the consumer | invalid |
| Internal business logic error | internal |

##### Response

Returns a [`ReopenTradelineOutput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ReopenTradelineOutput)

##### Arguments

| Name | Description |
| --- | --- |
| `input` \- [`ReopenTradelineInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ReopenTradelineInput) | Identifies the tradeline to reopen. |

#### Example

##### Query

```gql
mutation ReopenTradeline($input: ReopenTradelineInput!) {
  reopenTradeline(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
    }
  }
}
```

##### Variables

```json
{"input": ReopenTradelineInput}
```

##### Response

```json
{"data": {"reopenTradeline": {"tradeline": Tradeline}}}
```

# Types

## Address

##### Fields

| Field Name | Description |
| --- | --- |
| `line1` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The first line of the address. |
| `line2` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The second line of the address (optional). |
| `city` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The city of the address. |
| `state` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The state or province of the address (2 letter state code). |
| `country` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The country of the address. |
| `zipcode` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The postal or ZIP code of the address (5 digit zipcode). |
| `type` \- [`AddressType!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressType) | The type of address. |

##### Example

```json
{
  "line1": "123 Main St",
  "line2": "Apt 101",
  "city": "Athens",
  "state": "FL",
  "country": "USA",
  "zipcode": "37745",
  "type": "PRIMARY"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## AddressInput

##### Description

The input for a user's address. Fields must not contain emojis.

##### Fields

| Input Field | Description |
| --- | --- |
| `line1` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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`](https://developers.bloomcredit.io/page/enablement_gql_ref#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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The state or province of the address. Must be a valid 2 letter US state code. |
| `country` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The postal or ZIP code of the address. Must be a 5 digit number. |
| `type` \- [`AddressType!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressType) | The type of address. |

##### Example

```json
{
  "line1": "123 Main St",
  "line2": "Apt 101",
  "city": "Athens",
  "state": "FL",
  "country": "USA",
  "zipcode": "37745",
  "type": "PRIMARY"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## AddressType

##### 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. |

##### Example

```gql
"PRIMARY"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Boolean

##### Description

The `Boolean` scalar type represents `true` or `false`.

##### Example

```json
true
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## CloseTradelineOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `tradeline` \- [`Tradeline!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline) | The tradeline that was closed. |

##### Example

```json
{"tradeline": Tradeline}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Connection

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the connection. |
| `status` \- [`ConnectionStatus!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ConnectionStatus) | The current status of the connection. |
| `institution` \- [`Institution!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Institution) | The financial institution associated with the connection. |
| `financialAccounts` \- [`[FinancialAccount!]`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-FinancialAccount) | The financial accounts associated with the connection. |
| `user` \- [`User!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) | The user associated with the connection. |

##### Example

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "ACTIVE",
  "institution": Institution,
  "financialAccounts": [FinancialAccount],
  "user": User
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ConnectionFilter

##### Fields

| Input Field | Description |
| --- | --- |
| `status` \- [`ConnectionStatus`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ConnectionStatus) | Filter by connection status. |

##### Example

```json
{"status": "ACTIVE"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ConnectionStatus

##### 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 |

##### Example

```gql
"ACTIVE"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ConnectionsConnection

##### Fields

| Field Name | Description |
| --- | --- |
| `edges` \- [`[ConnectionsEdge!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ConnectionsEdge) | An array of connection edges |
| `pageInfo` \- [`PageInfo!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-PageInfo) | PageInfo provides information about the paginated collection. |

##### Example

```json
{
  "edges": [ConnectionsEdge],
  "pageInfo": PageInfo
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ConnectionsEdge

##### Description

The connections returned for a given user.

##### Fields

| Field Name | Description |
| --- | --- |
| `cursor` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Connection) | The connection object. |

##### Example

```json
{
  "cursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
  "node": Connection
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ConnectionsInput

##### Description

The input required to query the connections that exist for a given user.

##### Fields

| Input Field | Description |
| --- | --- |
| `first` \- [`Int`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) | This is a pagination parameter. (I.e. get the first N records). |
| `after` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | This is a pagination parameter. (I.e. get the first N records AFTER this cursor). |
| `filter` \- [`ConnectionFilter`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ConnectionFilter) | Filter by connection status. |

##### Example

```json
{
  "first": 5,
  "after": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
  "filter": ConnectionFilter
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## CurrencyCode

##### Values

| Enum Value | Description |
| --- | --- |
| `USD` | The currency code for USD. |

##### Example

```gql
"USD"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Date

##### Description

A date in the format YYYY-MM-DD.

##### Example

```gql
"2007-12-03"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## DateInput

##### Fields

| Input Field | Description |
| --- | --- |
| `day` \- [`Int!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) |  |
| `month` \- [`Int!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) |  |
| `year` \- [`Int!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) |  |

##### Example

```json
{"day": "14", "month": "6", "year": "1986"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## DeleteConnectionOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `connection` \- [`Connection!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Connection) | The deleted connection object. |

##### Example

```json
{"connection": Connection}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## DeleteMeOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `user` \- [`User!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) | Returned user object |

##### Example

```json
{"user": User}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## DeleteTradelineInput

##### Description

Input for the deleteTradeline mutation (soft-delete due to fraud).

##### Fields

| Input Field | Description |
| --- | --- |
| `tradelineId` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | Unique tradeline identifier. |

##### Example

```json
{
  "tradelineId": "00000000-0000-0000-0000-000000000000"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## DeleteTradelineOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `tradeline` \- [`Tradeline!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline) | The tradeline that was deleted (soft-deleted). |

##### Example

```json
{"tradeline": Tradeline}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## FinancialAccount

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the financial account. |
| `name` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The name of the financial account. |
| `type` \- [`FinancialAccountType!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-FinancialAccountType) | The type of the financial account. |
| `mask` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The mask of the financial account (usually the last 4 digits of the account number). |
| `institution` \- [`Institution!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Institution) | The institution associated with the financial account. |
| `connection` \- [`Connection`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Connection) | The current connection for this financial account. |

##### Example

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "xyz789",
  "type": "DEPOSITORY",
  "mask": "abc123",
  "institution": Institution,
  "connection": Connection
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## FinancialAccountType

##### 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. |

##### Example

```gql
"DEPOSITORY"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Furnishment

##### Description

The furnishment object.

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the furnishment. |
| `furnishedAt` \- [`Time!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The time the data was furnished. |

##### Example

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "furnishedAt": "10:15:30Z"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ID

##### Description

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.

##### Example

```gql
"00000000-0000-0000-0000-000000000000"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ImportConnectionsInput

##### Fields

| Input Field | Description |
| --- | --- |
| `tokens` \- [`[String!]`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The Plaid access tokens or Processor tokens. |
| `tokensWithMetadata` \- [`[ProcessorTokenWithMetadata!]`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ProcessorTokenWithMetadata) |  |

##### Example

```json
{
  "tokens": ["abc123"],
  "tokensWithMetadata": [ProcessorTokenWithMetadata]
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ImportConnectionsOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `connections` \- [`[Connection!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Connection) | The created connection objects. |

##### Example

```json
{"connections": [Connection]}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ImportPlaidProcessorTokensInput

##### Fields

##### Example

```json
{
  "tokens": ["xyz789"],
  "tokensWithMetadata": [ProcessorTokenWithMetadata]
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ImportPlaidProcessorTokensOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `successes` \- [`[ProcessorTokenImportSuccess!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ProcessorTokenImportSuccess) |  |
| `failures` \- [`[TokenError!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TokenError) |  |

##### Example

```json
{
  "successes": [ProcessorTokenImportSuccess],
  "failures": [TokenError]
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ImportUserInput

##### Fields

| Input Field | Description |
| --- | --- |
| `id` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The ID of the consumer to import. This corresponds to the bloom consumer identifier used in [the core consumers endpoints](https://developers.bloomcredit.io/reference/getconsumerv2-1) |

##### Example

```json
{"id": "00000000-0000-0000-0000-000000000000"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ImportUserOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `user` \- [`User!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) | The enablement user object created as a result of the import. |

##### Example

```json
{"user": User}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Institution

##### Fields

| Field Name | Description |
| --- | --- |
| `name` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The name of the financial institution. |
| `logoUrl` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The logo URL of the financial institution. |

##### Example

```json
{"name": "bloom", "logoUrl": "https://example.com/logo.png"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Int

##### Description

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

##### Example

```json
987
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Money

##### Description

The money object.

##### Fields

| Field Name | Description |
| --- | --- |
| `amount` \- [`Int!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) | The amount of money. |
| `currency` \- [`CurrencyCode!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-CurrencyCode) | The currency of the money. |

##### Example

```json
{"amount": 987, "currency": "USD"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Name

##### Fields

| Field Name | Description |
| --- | --- |
| `first` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | A user's legal first name. |
| `middle` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | A user's legal middle name or initial. (optional) |
| `last` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | A user's legal last name. |

##### Example

```json
{"first": "Buzz", "middle": "Z", "last": "Inga"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## NameInput

##### Fields

| Input Field | Description |
| --- | --- |
| `first` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The users legal first name |
| `middle` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The users legal middle name (optional) |
| `last` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The users legal last name |

##### Example

```json
{"first": "Buzz", "middle": "Z", "last": "Inga"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Node

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the node. |

##### Possible Types

| Node Types |
| --- |
| [`FinancialAccount`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-FinancialAccount) |
| [`Connection`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Connection) |
| [`Transaction`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Transaction) |
| [`User`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) |

##### Example

```json
{
  "id": "00000000-0000-0000-0000-000000000000"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## NotificationType

##### 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. |

##### Example

```gql
"EMAIL"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## OpenRentTradelineOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `tradeline` \- [`Tradeline`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline) | The tradeline that was opened. |

##### Example

```json
{"tradeline": Tradeline}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## OpenTelcoTradelineOutput

##### Fields

##### Example

```json
{"tradeline": Tradeline}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## OpenUtilityTradelineOutput

##### Fields

##### Example

```json
{"tradeline": Tradeline}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## PageInfo

##### Description

PageInfo provides information about the paginated collection.

##### Fields

| Field Name | Description |
| --- | --- |
| `hasNextPage` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if there is a next page. |
| `endCursor` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The cursor for the end of the current page. |

##### Example

```json
{
  "hasNextPage": true,
  "endCursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## PaymentFrequency

##### Description

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. |

##### Example

```gql
"UNKNOWN"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ProcessorTokenImportSuccess

##### Fields

| Field Name | Description |
| --- | --- |
| `token` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) |  |
| `connection` \- [`Connection!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Connection) |  |

##### Example

```json
{
  "token": "xyz789",
  "connection": Connection
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ProcessorTokenWithMetadata

##### Fields

| Input Field | Description |
| --- | --- |
| `token` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) |  |
| `historicalSyncComplete` \- [`Boolean`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) |  |

##### Example

```json
{
  "token": "xyz789",
  "historicalSyncComplete": true
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ReOpenOrganizationUserInput

##### Fields

| Input Field | Description |
| --- | --- |
| `userId` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier of the closed user to reopen. |

##### Example

```json
{
  "userId": "00000000-0000-0000-0000-000000000000"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ReOpenOrganizationUserOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `user` \- [`User`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) | The user that was reopened. |

##### Example

```json
{"user": User}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## RegisterOrganizationUserInput

##### Fields

| Input Field | Description |
| --- | --- |
| `organizationSlug` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | URL-friendly name of the organization. |
| `email` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The email address of the user. |
| `phoneNumber` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The phone number of the user. Must be a US phone number. |
| `name` \- [`NameInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-NameInput) | The name of the user. |
| `address` \- [`AddressInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressInput) | The address of the user. |
| `dateOfBirth` \- [`DateInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The national ID of the user (optional). |
| `visitorID` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The visitor ID for tracking purposes (optional). |

##### Example

```json
{
  "organizationSlug": "bloom",
  "email": "buzz.inga@bloomcredit.io",
  "phoneNumber": "+12345678901",
  "name": NameInput,
  "address": AddressInput,
  "dateOfBirth": DateInput,
  "nationalId": "12345",
  "visitorID": "12345"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## RegisterOrganizationUserOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `user` \- [`User`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) | The user object created as a result of the registration. |

##### Example

```json
{"user": User}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## RentTradelineDetails

##### Description

The details associated with a rent tradeline.

##### Fields

| Field Name | Description |
| --- | --- |
| `serviceAddressString` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | Service address of the tradeline. |
| `serviceAddressType` \- [`AddressType!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressType) | Type of service address. |
| `leaseStartDate` \- [`Date!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Date) | The start date of the lease. |
| `isPrimaryAddress` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if this is the primary address. |
| `hasOtherMortgageOrRent` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if there are other mortgage or rent obligations. |

##### Example

```json
{
  "serviceAddressString": "xyz789",
  "serviceAddressType": "PRIMARY",
  "leaseStartDate": "2007-12-03",
  "isPrimaryAddress": false,
  "hasOtherMortgageOrRent": true
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## RentTradelineInput

##### Fields

| Input Field | Description |
| --- | --- |
| `serviceAddressString` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The service address of the tradeline. |
| `serviceAddressType` \- [`AddressType`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressType) | The type of service address. |
| `leaseStartDate` \- [`Date`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Date) | The start date of the lease. |
| `isPrimaryAddress` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if this is the primary address. |
| `hasOtherMortgageOrRent` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if there are other mortgage or rent obligations. |

##### Example

```json
{
  "serviceAddressString": "xyz789",
  "serviceAddressType": "PRIMARY",
  "leaseStartDate": "2007-12-03",
  "isPrimaryAddress": false,
  "hasOtherMortgageOrRent": false
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ReopenTradelineInput

##### Description

Input for the reopenTradeline mutation.

##### Fields

| Input Field | Description |
| --- | --- |
| `tradelineId` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | Unique identifier of the tradeline to reopen. |

##### Example

```json
{
  "tradelineId": "00000000-0000-0000-0000-000000000000"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ReopenTradelineOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `tradeline` \- [`Tradeline!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline) | The tradeline that was reopened. |

##### Example

```json
{"tradeline": Tradeline}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## String

##### Description

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.

##### Example

```gql
"xyz789"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TelcoTradelineDetails

##### Description

The details associated with a telco tradeline.

##### Fields

| Field Name | Description |
| --- | --- |
| `servicePhone` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | Service phone number of the tradeline. |

##### Example

```json
{"servicePhone": "abc123"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TelcoTradelineInput

##### Fields

| Input Field | Description |
| --- | --- |
| `servicePhone` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The service phone number of the tradeline. |

##### Example

```json
{"servicePhone": "abc123"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Time

##### Description

An RFC3339 formatted timestamp.

##### Example

```gql
"10:15:30Z"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TokenError

##### Fields

| Field Name | Description |
| --- | --- |
| `token` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) |  |
| `error` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) |  |

##### Example

```json
{
  "token": "abc123",
  "error": "abc123"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Tradeline

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the tradeline. |
| `user` \- [`User!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-User) | The user that owns the tradeline. |
| `merchant` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The merchant associated with the tradeline. |
| `category` \- [`TradelineCategory!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TradelineCategory) | The category of the tradeline. |
| `status` \- [`TradelineStatus!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TradelineStatus) | The status of the tradeline. |
| `isEligible` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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:<br>- The tradeline has a payment frequency of bi-weekly or less frequent. (NOT DAILY/WEEKLY)<br>- The tradeline is an eligible category. (RENT, UTILITY, TELCO, SUBSCRIPTION)<br>- The tradeline has a transaction within the last 90 days, and at least 3 transactions total. |
| `paymentFrequency` \- [`PaymentFrequency!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-PaymentFrequency) | The payment frequency of the tradeline. |
| `lastTransactionDate` \- [`Date!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Date) | The last transaction date of the tradeline. |
| `transactionCount` \- [`Int!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) | The number of transactions associated with the tradeline. |
| `details` \- [`TradelineDetails`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TradelineDetails) | The details associated with the tradeline. |
| `createdAt` \- [`Time!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The time the tradeline was created. |
| `updatedAt` \- [`Time!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The time the tradeline was last updated. |
| `transactions` \- [`TransactionsConnection!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TransactionsConnection) | The transactions associated with the tradeline. |
| ##### Arguments<br>###### `input` \- [`TransactionsInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref\#definition-TransactionsInput) |
| `furnishments` \- [`[Furnishment]`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Furnishment) | Furnishment data associated to the tradeline |
| `financialAccount` \- [`FinancialAccount`](https://developers.bloomcredit.io/page/enablement_gql_ref#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`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The account number reported to credit bureaus for this tradeline. |

##### Example

```json
{
  "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": "abc123"
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TradelineCategory

##### 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. |

##### Example

```gql
"RENT"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TradelineDetails

##### Description

The details associated with a tradeline. See individual types for more details.

##### Types

| Union Types |
| --- |
| [`RentTradelineDetails`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-RentTradelineDetails) |
| [`UtilityTradelineDetails`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-UtilityTradelineDetails) |
| [`TelcoTradelineDetails`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TelcoTradelineDetails) |

##### Example

```gql
RentTradelineDetails
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TradelineStatus

##### 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). |

##### Example

```gql
"UNOPENED"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TradelinesConnection

##### Fields

| Field Name | Description |
| --- | --- |
| `edges` \- [`[TradelinesEdge!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TradelinesEdge) | The edges of the tradelines connection. |
| `pageInfo` \- [`PageInfo!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-PageInfo) | The pagination information for the tradelines connection. |

##### Example

```json
{
  "edges": [TradelinesEdge],
  "pageInfo": PageInfo
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TradelinesEdge

##### Description

The tradelines returned for a given connection.

##### Fields

| Field Name | Description |
| --- | --- |
| `cursor` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline) | The tradeline object. |

##### Example

```json
{
  "cursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
  "node": Tradeline
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TradelinesInput

##### Fields

| Input Field | Description |
| --- | --- |
| `first` \- [`Int`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Int) | This is a pagination parameter. (I.e. get the first N records). |
| `after` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | This is a pagination parameter. (I.e. get the first N records AFTER this cursor). |
| `status` \- [`TradelineStatus`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TradelineStatus) | Filter by the status of the tradeline. |
| `isEligible` \- [`Boolean`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Filter by whether or not the tradeline is eligible for reporting to the credit bureaus. |

##### Example

```json
{"first": 5, "after": "3", "status": "UNOPENED", "isEligible": true}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## Transaction

##### Description

The transaction object.

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | The unique identifier for the transaction. |
| `date` \- [`Date!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Date) | The date of the transaction. |
| `value` \- [`Money!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Money) | The value of the transaction. |
| `tradeline` \- [`Tradeline!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Tradeline) | The tradeline that the transaction is associated with. |

##### Example

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "date": "2007-12-03",
  "value": Money,
  "tradeline": Tradeline
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TransactionsConnection

##### Fields

| Field Name | Description |
| --- | --- |
| `edges` \- [`[TransactionsEdge]`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TransactionsEdge) | The edges of the transactions connection. |
| `pageInfo` \- [`PageInfo!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-PageInfo) | The pagination information for the transactions connection. |

##### Example

```json
{
  "edges": [TransactionsEdge],
  "pageInfo": PageInfo
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TransactionsEdge

##### Description

The transactions returned for a given connection.

##### Fields

| Field Name | Description |
| --- | --- |
| `cursor` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#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!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Transaction) | The transaction object. |

##### Example

```json
{
  "cursor": "MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw",
  "node": Transaction
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## TransactionsInput

##### Fields

| Input Field | Description |
| --- | --- |
| `first` \- [`Int`](https://developers.bloomcredit.io/page/enablement_gql_ref#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`](https://developers.bloomcredit.io/page/enablement_gql_ref#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. |

##### Example

```json
{"first": 5, "after": "3"}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## User

##### Description

The user type

##### Fields

| Field Name | Description |
| --- | --- |
| `id` \- [`ID!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ID) | Global identifier for the user. |
| `email` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | User's email address |
| `phoneNumber` \- [`String!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | User's phone number |
| `name` \- [`Name!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Name) | User's name |
| `address` \- [`Address!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Address) | User's address |
| `status` \- [`UserStatus!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-UserStatus) | User's status |
| `notificationPreferences` \- [`NotificationType!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-NotificationType) | Notifications are currently not sent for enablement Services. |
| `createdAt` \- [`Time!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The time the user was created in the database. |
| `updatedAt` \- [`Time!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The last time the user was updated. |
| `syncedAt` \- [`Time`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The last time this user's connections were synced. |
| `closedAt` \- [`Time`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Time) | The time this user profile was closed. |
| `connections` \- [`ConnectionsConnection!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-ConnectionsConnection) | The financial institution connections the user has created. |
| ##### Arguments<br>###### `input` \- [`ConnectionsInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref\#definition-ConnectionsInput) |
| `tradelines` \- [`TradelinesConnection!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-TradelinesConnection) | The tradelines associated with the connected financial institution(s) this user has connected. |
| ##### Arguments<br>###### `input` \- [`TradelinesInput!`](https://developers.bloomcredit.io/page/enablement_gql_ref\#definition-TradelinesInput) |

##### 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
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## UserStatus

##### 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. |

##### Example

```gql
"PENDING"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## UtilityTradelineDetails

##### Description

The details associated with a utility tradeline.

##### Fields

| Field Name | Description |
| --- | --- |
| `serviceAddressString` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | Service address of the tradeline. |
| `serviceAddressType` \- [`AddressType!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressType) | Type of service address. |
| `isPrimaryAddress` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if this is the primary address. |
| `utilityTypes` \- [`[UtilityType!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-UtilityType) | The utility types associated with the tradeline. |

##### Example

```json
{
  "serviceAddressString": "xyz789",
  "serviceAddressType": "PRIMARY",
  "isPrimaryAddress": true,
  "utilityTypes": ["WATER"]
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## UtilityTradelineInput

##### Fields

| Input Field | Description |
| --- | --- |
| `serviceAddressString` \- [`String`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-String) | The service address of the tradeline. |
| `serviceAddressType` \- [`AddressType`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-AddressType) | The type of service address. |
| `isPrimaryAddress` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | Indicates if this is the primary address. |
| `utilityTypes` \- [`[UtilityType!]!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-UtilityType) | The utility types associated with the tradeline. If the additional utility type is provided, another type must be included. |

##### Example

```json
{
  "serviceAddressString": "abc123",
  "serviceAddressType": "PRIMARY",
  "isPrimaryAddress": false,
  "utilityTypes": ["WATER"]
}
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## UtilityType

##### 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. |

##### Example

```gql
"WATER"
```

[Types](https://developers.bloomcredit.io/page/enablement_gql_ref#group-Types)

## ValidateDateOfBirthOutput

##### Fields

| Field Name | Description |
| --- | --- |
| `isValid` \- [`Boolean!`](https://developers.bloomcredit.io/page/enablement_gql_ref#definition-Boolean) | The result of the birthdate validation |

##### Example

```json
{"isValid": true}
```

[Documentation by Anvil SpectaQL](https://github.com/anvilco/spectaql)