Create External Account
Overview
You can create one or multiple external accounts for a customer or program manager using the POST method as described below.
Resource Access
Production (api.ahrvo.network)
POST https://api.ahrvo.network/banking/us2/v1/customer/id/{customerId}/externalAccount
Staging (gateway.ahrvo.network)
POST https://gateway.ahrvo.network/banking/us2/v1/customer/id/{customerId}/externalAccount
Arguments
| Attribute | M / O | Notes |
|---|---|---|
externalId | O | Client reference |
holderName | M | Account-holder’s full name |
holderPhone | O | E.164 or local format |
holderAddress.addressLine1 | O | — |
holderAddress.addressLine2 | O | — |
holderAddress.city | M | — |
holderAddress.state | M | Two-letter code |
holderAddress.zip | M | 5- or 9-digit ZIP |
accountNumber | M | Numeric string |
routingNumber | M | 9-digit ABA |
wireRoutingNumber | O | For wires (if different) |
type | M | CHECKING, SAVINGS, etc. |
holderType | M | CONSUMER | BUSINESS |
purpose | O | Free-form description |
validateAccount.ews | O | true to perform EWS |
prenote | O | ALWAYS, NEVER, etc. |
microDeposit | O | ALWAYS, NEVER, etc. |
metaData | O | Up to 20 key–value pairs |
tags | O | Array of labels |
linkedDocument.purpose | M | Reason for document |
linkedDocument.document.documentType | M | MIME/enum value |
linkedDocument.document.name | M | File name |
linkedDocument.document.base64encodedContent | M | Base-64 payload |
linkedDocument.document.externalId | O | Document reference |
comment | O | Internal note |
Example Request
Create an external account for a customer
POST /v1/customer/id/4052981/externalAccount HTTP/1.1
Host: {placeholder("hostname")}
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {apiKey}
Content-Type: application/json
{
"externalId": "EID289742235111783196",
"holderName": "Jon Francis",
"holderPhone": "573-986-1372",
"holderAddress": {
"addressLine1": "999",
"addressLine2": "GT1 KMB",
"city": "Arizona",
"state": "AZ",
"zip": "85002"
},
"accountNumber": "558299892760001",
"type": "SAVINGS",
"routingNumber": "011000015",
"wireRoutingNumber": "011000015",
"holderType": "CONSUMER",
"comment": "Jon's account",
"tags": [
"Jon's external acc"
],
"metaData": {
"label": "EA for Jon"
},
"validateAccount": [
{
"ews": true
}
],
"microDeposit": "NEVER",
"prenote": "NEVER"
}
Example Response
HTTP/1.1 201 Created
Content-Type: application/json
Location: /banking/us2/v1/customer/4052981/externalAccount/id/3
{
"url": "v1/customer/4052981/externalAccount/id/3"
}