Accounts
Update access to account
Accounts
Update access to account
You can use this endpoint to update the access of an api client within an account.
PUT
/
v1
/
accounts
/
{accountId}
/
access
Authorizations
Authorization
string
headerrequiredNomba 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
requiredThe parent accountId of the business.
Path Parameters
accountId
string
requiredThe account, where access is to be updated.
Body
application/json
grantType
enum<string>
requiredThe action to perform on the access
Available options:
allow, deny clientId
string
requiredThe client to grant/deny access to the account
role
enum<string>
default: ACCOUNT_WRITERrequiredThe role to assume within the account
Available options:
ACCOUNT_WRITER, ACCOUNT_READER Response
200 - application/json
code
string
requiredResponse Code
description
string
requiredResponse description
data
object
requiredA structure representing a bank account lookup result