Overview

The Account Connection object represents the relationship between your enterprise and a creator. It includes such details as the creator’s name, how they’ve connected (Manifest or ACH), and what permissions they have granted you. For a typical integration, you’ll create one Account Connection for each creator in your system, and store the ID with your creator data. You can do this ahead of time, say during creator enrollment in your system, or right after a creator requests to be paid by Manifest. Either way, an Account Connection must be created before a Connect Link can be generated or a Connect Invite can be sent.

Methods

Create
Get
Get by External ID
Update
List

POST /account-connection
Create a new account connection under your enterprise.

Body Parameters

string

required

Legal first name from your records.

string

required

Legal last name from your records.

string

Optional user identifier from your system. If set, Manifest will enforce uniqueness, e.g. attempts to create a second account connection for the same user will fail.This should be a stable value like a User ID, not something that might change like an email address or phone number. This value should not contain any sensitive information.

string

required

Email address from your records. See sandbox testing for more information about using emails in sandbox.

string

Legal business name of the creator from your records, if applicable.

string

Display name, visible to the creator. Examples: a band name, online persona, or shortened version of the business name.

string[]

required

Array of permissions to request from the user during the Connect flow. See below for details.

string

required

Text to prompt your users for their verification answer. Examples below.

string

required

Required answer to the verification prompt. Manifest will correct for case sensitivity and trim excess white space before comparing the user’s entered value. Any special formatting requirements should either be avoided or included in the verification prompt itself.

string

You can set a legacy payment method on new account connections. See below for available options and required fields.

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// POST /account-connection
{
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "display_name": "The Beatles",
    "requested_permissions": ["payment.credit"],
    "verification_prompt": "Please enter the last 4 digits of your tax ID.",
    "verification_answer": "1234"
}

{
    "id": "acon_XXXXX",
    "status": "created",
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "display_name": "The Beatles",
    "requested_permissions": ["payment.credit"],
    "verification_prompt": "Please enter the last 4 digits of your tax ID.",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z"
}

GET /account-connection/:id
Retrieve an account connection by its ID.

Path Parameters

string

required

The ID of the account connection to retrieve.

Example

{
    "id": "acon_XXXXX",
    "status": "created",
    "type": "direct",
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "display_name": "The Beatles",
    "permissions": [{"name": "payment.credit"}],
    "requested_permissions": ["payment.credit"],
    "verification_prompt": "Please enter the last 4 digits of your tax ID.",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z",
    "destination": "Manifest Account - Paul McCartney"
}

GET /account-connection/external/:external_id
Get details of one of your enterprise’s account connections by your own user identifier. (Must set external_id during account connection creation to use this method.)

Path Parameters

string

required

User identifier from your system.

Example

{
    "id": "acon_XXXXX",
    "external_id": "AB789",
    "status": "created",
    "type": "direct",
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "display_name": "The Beatles",
    "permissions": [{"name": "payment.credit"}],
    "requested_permissions": ["payment.credit"],
    "verification_prompt": "Please enter the last 4 digits of your tax ID.",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z",
    "destination": "Manifest Account - Paul McCartney",
}

PUT /account-connection/:id
Update data associated with one of your enterprise’s connections.

Path Parameters

string

required

The ID of the account connection to update.

Body Parameters

string

Update to deleted to deactivate this account connection.

string

Legal first name as represented in your system.

string

Legal last name as represented in your system.

string

Email address from your records.

string

Display name, visible to the creator. Examples are a band name, an online persona, or shortened version of the business name.

string

Legal business name from your records.

string[]

Array of permissions to request from the user during the Connect flow. See below for details.

string

Text to prompt your users for their verification answer. Examples below.

string

You can set a legacy payment method on new account connections. See below for available options and required fields.

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// PUT /account-connection/acon_XXXXX
{
    "first_name": "Linda",
    "email": "linda@gmail.com"
}

{
    "id": "acon_XXXXX",
    "status": "active",
    "type": "direct",
    "first_name": "Linda",
    "last_name": "McCartney",
    "email": "linda@gmail.com",
    "display_name": "The Beatles",
    "permissions": [{"name": "payment.credit"}],
    "requested_permissions": ["payment.credit"],
    "verification_prompt": "Please enter the last 4 digits of your tax ID.",
    "user_data": {},
    "created_at": "2024-11-12T20:22:49.075Z",
    "updated_at": "2024-11-12T20:22:49.075Z",
    "destination": "Paul McCartney - Manifest Debit (*1234)"
}

GET /account-connection
List all connections associated with your enterprise.

Query Parameters

integer

The page number to return. Default is 1.

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "acon_XXXXX",
            "status": "active",
            "type": "direct",
            "first_name": "Paul",
            "last_name": "McCartney",
            "email": "paul@thebeatles.com",
            "display_name": "The Beatles",
            "permissions": [{"name": "payment.credit"}],
            "requested_permissions": ["payment.credit"],
            "verification_prompt": "Please enter the last 4 digits of your tax ID.",
            "user_data": {},
            "created_at": "2024-11-12T20:22:49.075Z",
            "updated_at": "2024-11-12T20:22:49.075Z"
        },
        {
            "id": "acon_YYYYY",
            "status": "created",
            "first_name": "John",
            "last_name": "Lennon",
            "email": "john@thebeatles.com",
            "display_name": "The Beatles",
            "requested_permissions": ["payment.credit"],
            "verification_prompt": "Please enter the last 4 digits of your tax ID.",
            "user_data": {},
            "created_at": "2024-11-12T20:22:49.075Z",
            "updated_at": "2024-11-12T20:22:49.075Z"
        },
        {
            "id": "acon_ZZZZZ",
            "status": "created",
            "first_name": "George",
            "last_name": "Harrison",
            "email": "george@thebeatles.com",
            "display_name": "The Beatles",
            "requested_permissions": ["payment.credit"],
            "verification_prompt": "Please enter the last 4 digits of your tax ID.",
            "user_data": {},
            "created_at": "2024-11-12T20:22:49.075Z",
            "updated_at": "2024-11-12T20:22:49.075Z"
        },
        {
            "id": "acon_00000",
            "status": "active",
            "type": "direct",
            "first_name": "Ringo",
            "last_name": "Starr",
            "email": "ringo@thebeatles.com",
            "display_name": "The Beatles",
            "permissions": [{"name": "payment.credit"}],
            "requested_permissions": ["payment.credit"],
            "verification_prompt": "Please enter the last 4 digits of your tax ID.",
            "user_data": {},
            "created_at": "2024-11-12T20:22:49.075Z",
            "updated_at": "2024-11-12T20:22:49.075Z"
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 4
    }
}

Properties

string

Identifier for this account connection.

string

Type of account connection. One of direct, ach, or wallet. This field will be populated once the creator has connected to your enterprise and selected a payout method.

string

Status of account connection. One of created, pending, active, or deleted. Only users can activate their connection (through the Connect flow).

string[]

Array of permissions to request from the user during the Connect flow. Possible values:

Permission	Description
`payment.credit`	Deposit to creator accounts.
`payment.debit`	Debit creator accounts. (type `direct` connections only)

Only ask for permissions you need to use; asking for more than you need might cause users to opt-out of connecting to you.

object[]

List of permissions granted by the creator during the Connect flow. Each permission object includes a name and an optional expires_at.

string

Legal first name from your records.

string

Legal last name from your records.

string

Email address from your records. Note, this does not need to match the user’s Manifest account email address, this is just an email address you use to communicate with this user. See sandbox testing for more information about using emails in sandbox.

string

Display name, visible to the creator. Examples are a band name, an online persona, or shortened version of the business name.

string

Legal business name from your records.

string

Text to prompt your users for their verification answer. Examples:

Please enter the last 4 digits of your tax ID.
Please enter your Triangle Artist ID.
Please enter the last 4 digits of the bank account number where you currently receive your Triangle payments.

string

object

An optional object describing legacy payout method details that can be set on new account connections. Used to migrate a creator’s existing payout method to Manifest. Details:

Show properties

    // Example ACH Object
    {
        "type": "ach",
        "name_on_account": "Paul McCartney",
        "account_number": "12341234",
        "routing_number": "111000025",
        "account_type": "checking",
        "first_name": "Paul",
        "last_name": "McCartney",
        "street_line_1": "123 Main St.",
        "city": "Austin",
        "state_abbreviation": "TX",
        "postal_code": "78704",
        "ssn": "111-99-1234"
    }

ACH Details

All fields in the example object are required. (There’s also an optional street_line_2.)
In addition to the bank account information, the collected personal info is used by Manifest for tax purposes.
account_number has a maximum length of 17 characters.
routing_number must be a valid 9-digit routing number.
account_type must be checking or savings.
postal_code must be 5 digits.
ssn must have 9 digits, and include dash formatting.

string

A plaintext label of the current destination account, suitable for display. (Not included in list endpoints.)

object

User defined data that can be attached to the object. See the User Data page for details.

Documentation

Sending Money

Receiving Money

Automations

Resources

Reference

Account Connections

Overview

Methods

Body Parameters

Example

Path Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Properties

​Overview

​Methods

​Body Parameters

​Example

​Path Parameters

​Example

​Path Parameters

​Example

​Path Parameters

​Body Parameters

​Example

​Query Parameters

​Example

​Properties

Overview

Methods

Body Parameters

Example

Path Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Properties