Admin API Reference

An Account represents the accounting of a banking relationship.

The date and time (ISO 8601 format) when the Account was created.

Account ID

The date and time (ISO 8601 format) when the Account was last updated.

Account

The ACH information represents the Account number and routing number used to process ACH transactions.

AccountACH

A Connection represents the data source for a Profile's accounts and transactions, such as a Plaid **Item** or MX **member**.

The easiest way to register connections is with the Quiltt Connector, which handles the configuration for Plaid Link and MX Connect.


The date and time (ISO 8601 format) when the Connection was created.

Connection ID

Represents the status of a Connection.

`INITIALIZING` - The Connection is being initialized.

`SYNCING` - The Connection is currently syncing.

`SYNCED` - The Connection is up to date.

`ERROR_REPAIRABLE` - The Connection has a repairable error. Initialize a Connector session for the user to repair the connection.

`ERROR_SERVICE` - Quiltt is experiencing a service interruption. Visit our [Status page](https://status.quiltt.io) for more information.

`ERROR_PROVIDER` - The Connection provider is experiencing a service interruption.

`ERROR_INSTITUTION` - The Connection provider is indicating an issue with the institution.


The date and time (ISO 8601 format) when the Connection was last updated.

Connection

An Event represents a change pertaining to data in your Quiltt Environment.

You can subscribe to one or more Event types by creating a Subscription. For example, you
can subscribe to `profile` and `connection` event types to be notified of all Events
pertaining to Profiles or Connections.

For greater control, you can also subscribe to more specific Events, such as
`profile.created` or `connection.synced.successful`.


Event ID

Profile ID

Profile UUID

Event

A Profile represents an entity with data in a Quiltt Environment, typically a physical person or company end-user of your application.

The date and time (ISO 8601 format) when the Profile was created.

The email associated with the Profile. This field can be used to power passwordless authentication in the Connector.

The full legal name, comprised from the given name and surname.

The phone number associated with the Profile. This field can be used to power passwordless authentication in the Connector.

The date and time (ISO 8601 format) when the Profile was last updated.

Profile

ProfileRequest

The Remote Data organized by server and endpoint.

RemoteMXAccount

Represents a list of Accounts with Remote Data.

RemoteAccount

RemoteAccounts

RemoteMXConnection

Represents a list of Connections with Remote Data.

RemoteConnection

RemoteConnections

Transaction ID

RemoteMXTransaction

Represents a list of Transactions with Remote Data.

RemoteTransaction

RemoteTransactions

RemotePaveProfile

Represents a list of Profiles with Remote Data.

RemoteProfile

RemoteProfiles

RemotePaveTransaction

The unique ID associated with a server error, used for troubleshooting

A helpful message to troubleshoot what went wrong

RestError

Represents Validation Errors saving or updating a record.

ValidationErrors

A webhook Payload represents the object that the Quiltt system will deliver to your Subscription's `targetUrl`, and will include one of more Events.

Environment ID

Environment

The types of events included in the Payload.

WebhookPayload

A Webhook Subscription represents the configuration of your webhook. You can subscribe to one or more Event types. When the subscribed events occur in the Quiltt system, the `targetUrl` will receive a Webhook Payload with the triggered Events.

The date and time (ISO 8601 format) when the Webhook Subscription was created.

The list of subscribed Event types. Note that parent types like `profile` will include child Events like `profile.created` and `profile.updated`.

Webhook Subscription ID

The URL that will receive the Webhook Payloads

The date and time (ISO 8601 format) when the Webhook Subscription was last updated.

WebhookSubscription

Options to create or update a Webhook Subscription

WebhookSubscriptionRequest

<pre><code>Authorization: Bearer {API_KEY_SECRET}</code></pre>

Pass your API Key secret as a bearer token in the Authorization header. You can access your
API Keys in the [Quiltt Dashboard](https://dashboard.quiltt.dev/api-keys).


# Overview
The Admin API allows you to manage Profiles and their data in your Quiltt Environment, and
is only appropriate for server-to-server use.

# API Host
<pre><code>https://api.quiltt.io</code></pre>

All Admin API requests must be made to the core API server.

# Authentication
<pre><code>Authorization: Bearer {API_KEY_SECRET}</code></pre>

All Admin API endpoints require a valid API Key secret to be passed in as a bearer
token in the Authorization header.

You can access your API Keys in the
[Quiltt Dashboard](https://dashboard.quiltt.dev/api-keys).


Admin API

Retrieves ACH routing and account numbers associated with a connected account.

These numbers can be sent to a payment processor to enable direct deposits and withdrawals
from the account.

Please note that for the numbers to become available, the account holder must have completed
a Connector session with the Account Verification feature. See the
[Connector guides](/guides/connector) for more information.


Returns a paginated list of all Profiles in your environment

page

items

Creates a Profile with supplied attributes

The Doctor

Deletes a Profile and its associated data

Returns a paginated list of Accounts with MX Data

accountId

Returns a paginated list of Connections with MX Data

connectionId

Returns a paginated list of Transactions with MX Data

transactionId

Returns a paginated list of Profiles that have Pave Data

profileId

Returns a paginated list of Transactions that have Pave Data

Returns a paginated list of your Subscriptions