Skip to main content
PATCH
/
accounts
/
{accountId}
Update account details
curl --request PATCH \
  --url https://api.venlyfinance.com/api/v1/accounts/{accountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>"
}
'
{
  "success": true,
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "status": "ACTIVE",
    "partyRoles": [
      {
        "partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "roleType": "ACCOUNT_HOLDER",
        "status": "ACTIVE",
        "party": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "externalId": "<string>",
          "partyType": "INDIVIDUAL",
          "status": "ACTIVE",
          "firstName": "<string>",
          "lastName": "<string>",
          "kycStatus": "PENDING",
          "name": "<string>",
          "vatNumber": "<string>",
          "kybStatus": "PENDING",
          "address": {
            "addressLine1": "<string>",
            "city": "<string>",
            "postalCode": "<string>",
            "country": "<string>",
            "addressLine2": "<string>",
            "state": "<string>"
          }
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

accountId
string<uuid>
required

Body

application/json

Update account details. Party details should be updated via the Party endpoints.

externalId
string
Maximum string length: 255

Response

Account updated

success
boolean

Indicates whether the request was successful

result
object