Begin customer onboarding application
curl --request POST \
--url https://api.anchorage-staging.com/v2/onboarding/customers \
--header 'Api-Access-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"affiliateId": "<string>",
"entries": [
{
"key": "<string>",
"value": "<string>"
}
],
"applicationType": "VA_INSTITUTION",
"applicationVersion": 0,
"externalId": "<string>",
"submit": true
}
'import requests
url = "https://api.anchorage-staging.com/v2/onboarding/customers"
payload = {
"affiliateId": "<string>",
"entries": [
{
"key": "<string>",
"value": "<string>"
}
],
"applicationType": "VA_INSTITUTION",
"applicationVersion": 0,
"externalId": "<string>",
"submit": True
}
headers = {
"Api-Access-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
affiliateId: '<string>',
entries: [{key: '<string>', value: '<string>'}],
applicationType: 'VA_INSTITUTION',
applicationVersion: 0,
externalId: '<string>',
submit: true
})
};
fetch('https://api.anchorage-staging.com/v2/onboarding/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"customerId": "<string>",
"status": "<string>",
"id": "<string>"
}
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}Begin customer onboarding application
Permissions required: Onboarding
Begin an onboarding application for a customer. Your organization must be enabled for the Onboarding API (ONBOARDING_API) and for customer onboarding (VA_OWNER_ONBOARDING); otherwise the request fails with 403 Virtual Account owner onboarding is not enabled for this organization.
Set applicationType to VA_INDIVIDUAL or VA_INSTITUTION, and affiliateId to the identifier Anchorage Digital provided when your organization was set up. Pass submit: true to submit the application in the same call.
POST
/
onboarding
/
customers
Begin customer onboarding application
curl --request POST \
--url https://api.anchorage-staging.com/v2/onboarding/customers \
--header 'Api-Access-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"affiliateId": "<string>",
"entries": [
{
"key": "<string>",
"value": "<string>"
}
],
"applicationType": "VA_INSTITUTION",
"applicationVersion": 0,
"externalId": "<string>",
"submit": true
}
'import requests
url = "https://api.anchorage-staging.com/v2/onboarding/customers"
payload = {
"affiliateId": "<string>",
"entries": [
{
"key": "<string>",
"value": "<string>"
}
],
"applicationType": "VA_INSTITUTION",
"applicationVersion": 0,
"externalId": "<string>",
"submit": True
}
headers = {
"Api-Access-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
affiliateId: '<string>',
entries: [{key: '<string>', value: '<string>'}],
applicationType: 'VA_INSTITUTION',
applicationVersion: 0,
externalId: '<string>',
submit: true
})
};
fetch('https://api.anchorage-staging.com/v2/onboarding/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"customerId": "<string>",
"status": "<string>",
"id": "<string>"
}
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}Body
application/json
Was this page helpful?