Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
funding-accounts

Nominate a bank account user

Nominate a bank account user.

When you nominate a user, BILL performs a set of operations.

  • The bank account user verificationStatus is set as NOMINATED.
  • BILL sends the user an email asking them to sign in to the BILL web app and complete identity verification. See Verify your identity in the Guides section for test verification information you can enter in the sandbox environment.

After user identity verification is successful, the bank account user verificationStatus is set as VERIFIED and the user can pay with the specified bank account.

Note: The bank account status must be set as VERIFIED before you can nominate bank account users.

post/v3/funding-accounts/banks/users/nominate

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

userIdstring required

BILL-generated ID of the user. The value begins with 006.

bankAccountIdstring required

BILL-generated ID of the bank account. The value begins with bac.

Note: The bank account status must be set as VERIFIED.

Example request

{
  "bankAccountId": "{{org_bank_account_id}}",
  "userId": "{{org_user_id}}"
}

Response

Nominate a bank account user response

status'SUCCESS' | 'FAILURE'

Request status