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

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

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

Getting Started

New here? Check out the 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 guide for reference.

Business logic errors (all return HTTP status 200):

Response

Returns a User

Example

Query

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

{
  "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

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 guide for reference.

Business logic errors (all return HTTP status 200):

Response

Returns a Tradeline

Arguments

Example

Query

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

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

Response

{
  "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

user

Description

Fetches a user by their ID or email address.

🔒 Authentication: Requires organization scoped authorization. See the Enablement Services Authorization guide for reference.

Business logic errors (all return HTTP status 200):

Response

Returns a User

Arguments

Example

Query

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

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

Response

{
  "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

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 guide for reference.

Business logic errors (all return HTTP status 200):

Response

Returns a Boolean!

Arguments

Example

Query

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

Variables

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

Response

{"data": {"userExistsWithEmail": false}}

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

Response

Returns a ValidateDateOfBirthOutput!

Arguments

Example

Query

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

Variables

{"dateOfBirth": DateInput}

Response

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

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 guide for reference.

Business logic errors (all return HTTP status 200):

Response

Returns a String!

Example

Query

query WebhookDashboardUrl {
  webhookDashboardUrl
}

Response

{"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):

Response

Returns a CloseTradelineOutput!

Arguments

Example

Query

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

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

Response

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

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!

Arguments

Example

Query

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

Variables

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

Response

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

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

Response

Returns a DeleteMeOutput!

Example

Query

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

Response

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

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!

Arguments

Example

Query

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

{"input": DeleteTradelineInput}

Response

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

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

Response

Returns an ImportConnectionsOutput!

Arguments

Example

Query

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

Variables

{"input": ImportConnectionsInput}

Response

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

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

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:

Response

Returns an ImportPlaidProcessorTokensOutput!

Arguments

Example

Query

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

Variables

{"input": ImportPlaidProcessorTokensInput}

Response

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

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

Response

Returns an ImportUserOutput!

Arguments

Example

Query

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

{"input": ImportUserInput}

Response

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

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

Note: If tradeline is already open with the same details, the mutation succeeds and returns the existing tradeline (idempotent behavior).

Response

Returns an OpenRentTradelineOutput!

Arguments

Example

Query

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

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

Response

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

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

Note: If tradeline is already open with the same details, the mutation succeeds and returns the existing tradeline (idempotent behavior).

Response

Returns an OpenTelcoTradelineOutput!

Arguments

Example

Query

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

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

Response

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

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

Note: If tradeline is already open with the same details, the mutation succeeds and returns the existing tradeline (idempotent behavior).

Response

Returns an OpenUtilityTradelineOutput!

Arguments

Example

Query

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

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

Response

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

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

Response

Returns a ReOpenOrganizationUserOutput!

Arguments

Example

Query

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

{"input": ReOpenOrganizationUserInput}

Response

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

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

Response

Returns a RegisterOrganizationUserOutput!

Arguments

Example

Query

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

{"input": RegisterOrganizationUserInput}

Response

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

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

Response

Returns a ReopenTradelineOutput!

Arguments

Example

Query

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

{"input": ReopenTradelineInput}

Response

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

Types

Address

Fields

Example

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

Types

AddressInput

Description

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

Fields

Example

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

Types

AddressType

Values

Example

"PRIMARY"

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

CloseTradelineOutput

Fields

Example

{"tradeline": Tradeline}

Types

Connection

Fields

Example

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

Types

ConnectionFilter

Fields

Example

{"status": "ACTIVE"}

Types

ConnectionStatus

Values

Example

"ACTIVE"

Types

ConnectionsConnection

Fields

Example

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

Types

ConnectionsEdge

Description

The connections returned for a given user.

Fields

Example

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

Types

ConnectionsInput

Description

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

Fields

Example

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

Types

CurrencyCode

Values

Example

"USD"

Types

Date

Description

A date in the format YYYY-MM-DD.

Example

"2007-12-03"

Types

DateInput

Fields

Example

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

Types

DeleteConnectionOutput

Fields

Example

{"connection": Connection}

Types

DeleteMeOutput

Fields

Example

{"user": User}

Types

DeleteTradelineInput

Description

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

Fields

Example

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

Types

DeleteTradelineOutput

Fields

Example

{"tradeline": Tradeline}

Types

FinancialAccount

Fields

Example

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

Types

FinancialAccountType

Values

Example

"DEPOSITORY"

Types

Furnishment

Description

The furnishment object.

Fields

Example

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

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

"00000000-0000-0000-0000-000000000000"

Types

ImportConnectionsInput

Fields

Example

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

Types

ImportConnectionsOutput

Fields

Example

{"connections": [Connection]}

Types

ImportPlaidProcessorTokensInput

Fields

Example

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

Types

ImportPlaidProcessorTokensOutput

Fields

Example

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

Types

ImportUserInput

Fields

Example

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

Types

ImportUserOutput

Fields

Example

{"user": User}

Types

Institution

Fields

Example

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

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

987

Types

Money

Description

The money object.

Fields

Example

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

Types

Name

Fields

Example

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

Types

NameInput

Fields

Example

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

Types

Node

Fields

Possible Types

Example

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

Types

NotificationType

Values

Example

"EMAIL"

Types

OpenRentTradelineOutput

Fields

Example

{"tradeline": Tradeline}

Types

OpenTelcoTradelineOutput

Fields

Example

{"tradeline": Tradeline}

Types

OpenUtilityTradelineOutput

Fields

Example

{"tradeline": Tradeline}

Types

PageInfo

Description

PageInfo provides information about the paginated collection.

Fields

Example

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

Types

PaymentFrequency

Description

How often the tradeline is paid.

Values

Example

"UNKNOWN"

Types

ProcessorTokenImportSuccess

Fields

Example

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

Types

ProcessorTokenWithMetadata

Fields

Example

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

Types

ReOpenOrganizationUserInput

Fields

Example

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

Types

ReOpenOrganizationUserOutput

Fields

Example

{"user": User}

Types

RegisterOrganizationUserInput

Fields

Example

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

Types

RegisterOrganizationUserOutput

Fields

Example

{"user": User}

Types

RentTradelineDetails

Description

The details associated with a rent tradeline.

Fields

Example

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

Types

RentTradelineInput

Fields

Example

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

Types

ReopenTradelineInput

Description

Input for the reopenTradeline mutation.

Fields

Example

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

Types

ReopenTradelineOutput

Fields

Example

{"tradeline": Tradeline}

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

"xyz789"

Types

TelcoTradelineDetails

Description

The details associated with a telco tradeline.

Fields

Example

{"servicePhone": "abc123"}

Types

TelcoTradelineInput

Fields

Example

{"servicePhone": "abc123"}

Types

Time

Description

An RFC3339 formatted timestamp.

Example

"10:15:30Z"

Types

TokenError

Fields

Example

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

Types

Tradeline

Fields

Example

{
  "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

TradelineCategory

Values

Example

"RENT"

Types

TradelineDetails

Description

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

Types

Example

RentTradelineDetails

Types

TradelineStatus

Values

Example

"UNOPENED"

Types

TradelinesConnection

Fields

Example

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

Types

TradelinesEdge

Description

The tradelines returned for a given connection.

Fields

Example

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

Types

TradelinesInput

Fields

Example

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

Types

Transaction

Description

The transaction object.

Fields

Example

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

Types

TransactionsConnection

Fields

Example

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

Types

TransactionsEdge

Description

The transactions returned for a given connection.

Fields

Example

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

Types

TransactionsInput

Fields

Example

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

Types

User

Description

The user type

Fields

Example

{
  "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

UserStatus

Values

Example

"PENDING"

Types

UtilityTradelineDetails

Description

The details associated with a utility tradeline.

Fields

Example

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

Types

UtilityTradelineInput

Fields

Example

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

Types

UtilityType

Values

Example

"WATER"

Types

ValidateDateOfBirthOutput

Fields

Example

{"isValid": true}

Documentation by Anvil SpectaQL