Update External Account
Overview
You can update selected details of an existing external account by sending a POST request to either the production or staging environment.
Resource Access
Production (api.ahrvo.network)
Staging (gateway.ahrvo.network)
Arguments
| Attribute | Can be updated? | Notes |
|---|---|---|
externalId | Conditional | Once set, cannot be changed. |
holderName | Yes | If the EA is Active, only holderName may change (triggers OFAC). |
accountNumber | No | — |
routingNumber | No | — |
wireRoutingNumber | No | — |
type | Yes | Only when EA is Inactive. |
holderType | No | — |
purpose | Yes | — |
validateAccount.ews | Yes | Only when EA is Inactive. |
prenote | Yes | Only when EA is Inactive. |
microDeposit | Yes | — |
metaData | Yes | Up to 20 key-value pairs. |
tags | Yes | Array of labels. |
linkedDocument | Yes | See mandatory sub-fields below. |
purpose | M | Purpose of document. |
document.documentType | M | MIME/enum value. |
document.name | M | File name. |
document.base64encodedContent | M | Base-64 payload. |
document.externalId | O | Document reference. |
comment | Yes | Internal note. |
M = Mandatory O = Optional
Example Request (production)
Perform account validation on an Inactive external account
POST /banking/us2/v1/customer/id/4052981/externalAccount/id/3 HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {apiKey}
Content-Type: application/json
{
"validateAccount": [
{
"ews": true
}
]
}
(For staging, replace api.ahrvo.network with gateway.ahrvo.network in both the Host header and the URL.)
Example Response
HTTP/1.1 299 Warning Content-Type: application/json WARN-0201: The external account will not be available for transaction processing until re-verified by Ahrvo.