PUT
/
v1
/
accounts
/
{subAccountId}
/
access

Authorizations

Authorization
string
headerrequired

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId
string
required

The parent accountId of the business.

Path Parameters

subAccountId
string
required

The account, where client access is to be updated.

Body

application/json

A structure representing an account access request

grantType
enum<string>
required

The action to perform on the access

Available options:
allow,
deny
clientId
string
required

The client to grant/deny access to the account

role
enum<string>
default: ACCOUNT_WRITERrequired

The role to assume within the account

Available options:
ACCOUNT_WRITER,
ACCOUNT_READER

Response

200 - application/json
code
string
required

Response Code

description
string
required

Response description

data
object
required

A structure representing a bank account lookup result