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 (Nerve 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 Nerve. Either way, an Account Connection must be created before a Connect Link can be generated or a Connect Invite can be sent.
Create Account Connection
Get Account Connection
Get Account Connection by External ID
Update Account Connection
List Account Connections
idstring Identifier for this account connection.
typestring Type of account connection. One of
ach. This field will populated once the creator has connected to your enterprise and selected a payout method.
statusstring Status of account connection. One of
deleted. Only users can activate their connection (through the Connect flow).
requested_permissionsstring Array of permissions to request from the user during the Connect flow. Possible values:
Only ask for permissions you need to use; asking for more than you need might cause users to opt-out of connecting to you.
permissionsobject List of permissions granted by the creator during the Connect flow. Each permission object includes a
nameand an optional
first_namestring Legal first name from your records.
last_namestring Legal last name from your records.
external_idstring Optional user identifier from your system. If set, Nerve 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.
business_namestring Legal business name from your records.
verification_promptstring Text to prompt your users for their verification answer. Examples:
Please enter the last 4 digits of your tax ID.
Please enter your Tape Daddy Artist ID.
Please enter the last 4 digits of the bank account number where you currently receive your Tape Daddy payments.
verification_answerstring Required answer to the verification prompt. Nerve 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.
legacy_payout_methodobject 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 Nerve. Options and requirements:
PayPal or Venmo
Example ACH Object
"name_on_account": "Paul McCartney",
"street_line_1": "123 Main St.",
- All fields in the example object are required. (There's also an optional
- In addition to the bank account information, the collected personal info is used by Nerve for tax purposes.
account_numberhas a maximum length of 17 characters.
routing_numbermust be a valid 9-digit routing number.
postal_codemust be 5 digits.
ssnmust have 9 digits, and include dash formatting.
destinationstring A plaintext label of the current destination account, suitable for display. (Not included in list endpoints.)