GraphQL API

GraphQL API Reference (New! 🚀)

For an automatically generated (and therefore up to date) API Reference, check out our generated [GraphQL Docs]
(https://developers.bloomcredit.io/page/enablement_gql_ref)!

GraphQL Playground (New! 🚀)

To run queries and mutations against our sandbox environment, we have a GraphQL playground.

🔧 In progress: We are working on adding a GraphQL explorer on top of our sandbox playground, to enable easier navigation through our GraphQL API.

GraphQL API Endpoint

Our GraphQL API is available with the following URLS, based on environment:

All mutations/queries require some form of authentication. See the Enablement Services Authenticate page for instructions on how to authenticate.

Creating a user

Once you’ve created a user in your application and completed any necessary KYC checks, the next step is to create a corresponding user in our database. This can be done using the registerUserOrganization mutation. This mutation will return the user object as it’s stored in our system, including a unique user_id. Be sure to save this user_id—it’s required for authenticating and accessing additional queries and mutations in our API.

Importing a Connection

After creating and authenticating your user or organization, the next step is to import the previously established aggregator connection. This allows our system to ingest and categorize transactions linked to that connection. To do this, use the importConnection mutation.

Additional queries can be found in our API References.