PUT
/
v1
/
accounts
/
{accountId}
/
access
curl --request PUT \
  --url https://api.nomba.com/v1/accounts/{accountId}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '{
  "clientId": "09132aea-367f-447d-9d9b-46af5a319318",
  "grantType": "allow",
  "role": "ACCOUNT_WRITER"
}'
{
  "code": "00",
  "data": {
    "data": "{\"name\": \"M.A Animashaun\", \"age\": 30, \"city\": \"Example City\"}",
    "message": "<string>"
  },
  "description": "Success"
}

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

accountId
string
required

The account, where access is to be updated.

Body

application/json
clientId
string
required

The client to grant/deny access to the account

grantType
enum<string>
required

The action to perform on the access

Available options:
allow,
deny
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

data
object
required

A structure representing a bank account lookup result

description
string
required

Response description