Update application
curl --request PATCH \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicant": {
"authentication": {
"password": "<string>"
},
"birthDate": "2023-12-25",
"disclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"hasAcceptedDisclosures": true,
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"isLegallyAuthorized": true,
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": {
"value": "<string>"
},
"signerDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"dbaName": "<string>",
"formationDate": "2023-12-25",
"legalName": "<string>",
"phoneNumber": "<string>",
"taxId": {
"value": "<string>"
},
"website": "<string>"
},
"businessOwners": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"birthDate": "2023-12-25",
"firstName": "<string>",
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": {
"value": "<string>"
}
}
],
"individualValidationSource": "<string>",
"organizationValidationSource": "<string>"
}
'import requests
url = "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}"
payload = {
"applicant": {
"authentication": { "password": "<string>" },
"birthDate": "2023-12-25",
"disclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"hasAcceptedDisclosures": True,
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"isLegallyAuthorized": True,
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": { "value": "<string>" },
"signerDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"dbaName": "<string>",
"formationDate": "2023-12-25",
"legalName": "<string>",
"phoneNumber": "<string>",
"taxId": { "value": "<string>" },
"website": "<string>"
},
"businessOwners": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"birthDate": "2023-12-25",
"firstName": "<string>",
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": { "value": "<string>" }
}
],
"individualValidationSource": "<string>",
"organizationValidationSource": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applicant: {
authentication: {password: '<string>'},
birthDate: '2023-12-25',
disclosuresAcceptedVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityDisclosuresAcceptedVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
firstName: '<string>',
hasAcceptedDisclosures: true,
homeAddress: {
address1: '<string>',
address2: '<string>',
address3: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>'
},
isLegallyAuthorized: true,
lastName: '<string>',
mobilePhoneNumber: '<string>',
ownershipPercentage: 123,
personalIdentificationNumber: {value: '<string>'},
signerDisclosuresAcceptedVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
workEmailAddress: '<string>'
},
businessDetails: {
address: {
address1: '<string>',
address2: '<string>',
address3: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>'
},
dbaName: '<string>',
formationDate: '2023-12-25',
legalName: '<string>',
phoneNumber: '<string>',
taxId: {value: '<string>'},
website: '<string>'
},
businessOwners: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
birthDate: '2023-12-25',
firstName: '<string>',
homeAddress: {
address1: '<string>',
address2: '<string>',
address3: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>'
},
lastName: '<string>',
mobilePhoneNumber: '<string>',
ownershipPercentage: 123,
personalIdentificationNumber: {value: '<string>'}
}
],
individualValidationSource: '<string>',
organizationValidationSource: '<string>'
})
};
fetch('https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'applicant' => [
'authentication' => [
'password' => '<string>'
],
'birthDate' => '2023-12-25',
'disclosuresAcceptedVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityDisclosuresAcceptedVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'firstName' => '<string>',
'hasAcceptedDisclosures' => true,
'homeAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'address3' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>'
],
'isLegallyAuthorized' => true,
'lastName' => '<string>',
'mobilePhoneNumber' => '<string>',
'ownershipPercentage' => 123,
'personalIdentificationNumber' => [
'value' => '<string>'
],
'signerDisclosuresAcceptedVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'workEmailAddress' => '<string>'
],
'businessDetails' => [
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'address3' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>'
],
'dbaName' => '<string>',
'formationDate' => '2023-12-25',
'legalName' => '<string>',
'phoneNumber' => '<string>',
'taxId' => [
'value' => '<string>'
],
'website' => '<string>'
],
'businessOwners' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'birthDate' => '2023-12-25',
'firstName' => '<string>',
'homeAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'address3' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>'
],
'lastName' => '<string>',
'mobilePhoneNumber' => '<string>',
'ownershipPercentage' => 123,
'personalIdentificationNumber' => [
'value' => '<string>'
]
]
],
'individualValidationSource' => '<string>',
'organizationValidationSource' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}"
payload := strings.NewReader("{\n \"applicant\": {\n \"authentication\": {\n \"password\": \"<string>\"\n },\n \"birthDate\": \"2023-12-25\",\n \"disclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"hasAcceptedDisclosures\": true,\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"isLegallyAuthorized\": true,\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n },\n \"signerDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workEmailAddress\": \"<string>\"\n },\n \"businessDetails\": {\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"dbaName\": \"<string>\",\n \"formationDate\": \"2023-12-25\",\n \"legalName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxId\": {\n \"value\": \"<string>\"\n },\n \"website\": \"<string>\"\n },\n \"businessOwners\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"birthDate\": \"2023-12-25\",\n \"firstName\": \"<string>\",\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n }\n }\n ],\n \"individualValidationSource\": \"<string>\",\n \"organizationValidationSource\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applicant\": {\n \"authentication\": {\n \"password\": \"<string>\"\n },\n \"birthDate\": \"2023-12-25\",\n \"disclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"hasAcceptedDisclosures\": true,\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"isLegallyAuthorized\": true,\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n },\n \"signerDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workEmailAddress\": \"<string>\"\n },\n \"businessDetails\": {\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"dbaName\": \"<string>\",\n \"formationDate\": \"2023-12-25\",\n \"legalName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxId\": {\n \"value\": \"<string>\"\n },\n \"website\": \"<string>\"\n },\n \"businessOwners\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"birthDate\": \"2023-12-25\",\n \"firstName\": \"<string>\",\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n }\n }\n ],\n \"individualValidationSource\": \"<string>\",\n \"organizationValidationSource\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applicant\": {\n \"authentication\": {\n \"password\": \"<string>\"\n },\n \"birthDate\": \"2023-12-25\",\n \"disclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"hasAcceptedDisclosures\": true,\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"isLegallyAuthorized\": true,\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n },\n \"signerDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workEmailAddress\": \"<string>\"\n },\n \"businessDetails\": {\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"dbaName\": \"<string>\",\n \"formationDate\": \"2023-12-25\",\n \"legalName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxId\": {\n \"value\": \"<string>\"\n },\n \"website\": \"<string>\"\n },\n \"businessOwners\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"birthDate\": \"2023-12-25\",\n \"firstName\": \"<string>\",\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n }\n }\n ],\n \"individualValidationSource\": \"<string>\",\n \"organizationValidationSource\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"applicant": {
"birthDate": "2023-12-25",
"disclosuresAcceptedAtDateTime": "2023-11-07T05:31:56Z",
"disclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"hasAcceptedDisclosures": true,
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"isLegallyAuthorized": true,
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumberLast4": "<string>",
"signerDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"businessStructureType": "CORPORATION_PUBLIC",
"dbaName": "<string>",
"legalName": "<string>",
"northAmericanIndustryClassificationSystemCode": "SOYBEAN_FARMING",
"phoneNumber": "<string>",
"taxIdLast4": "<string>",
"website": "<string>"
},
"businessOwners": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"birthDate": "2023-12-25",
"firstName": "<string>",
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumberLast4": "<string>"
}
],
"deniedAt": "2023-11-07T05:31:56Z",
"kycVerificationStatus": "PENDING",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "DRAFT",
"submittedAt": "2023-11-07T05:31:56Z",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "<string>",
"errorCode": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"errorCode": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Applications
Update application
Updates an existing application with applicant details, business details, and/or business owners in a single request. An omitted field preserves what is stored and an explicit null clears it, the identifiers included: sending personalIdentificationNumber or taxId as null erases it, and since a read returns only the last four digits it cannot be restored. A null password preserves.
Token types: APP | Required scopes: bank_account_application:write:org
PATCH
/
embedded-banking
/
v1
/
bank-account-applications
/
{id}
Update application
curl --request PATCH \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicant": {
"authentication": {
"password": "<string>"
},
"birthDate": "2023-12-25",
"disclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"hasAcceptedDisclosures": true,
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"isLegallyAuthorized": true,
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": {
"value": "<string>"
},
"signerDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"dbaName": "<string>",
"formationDate": "2023-12-25",
"legalName": "<string>",
"phoneNumber": "<string>",
"taxId": {
"value": "<string>"
},
"website": "<string>"
},
"businessOwners": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"birthDate": "2023-12-25",
"firstName": "<string>",
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": {
"value": "<string>"
}
}
],
"individualValidationSource": "<string>",
"organizationValidationSource": "<string>"
}
'import requests
url = "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}"
payload = {
"applicant": {
"authentication": { "password": "<string>" },
"birthDate": "2023-12-25",
"disclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"hasAcceptedDisclosures": True,
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"isLegallyAuthorized": True,
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": { "value": "<string>" },
"signerDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"dbaName": "<string>",
"formationDate": "2023-12-25",
"legalName": "<string>",
"phoneNumber": "<string>",
"taxId": { "value": "<string>" },
"website": "<string>"
},
"businessOwners": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"birthDate": "2023-12-25",
"firstName": "<string>",
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumber": { "value": "<string>" }
}
],
"individualValidationSource": "<string>",
"organizationValidationSource": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applicant: {
authentication: {password: '<string>'},
birthDate: '2023-12-25',
disclosuresAcceptedVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityDisclosuresAcceptedVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
firstName: '<string>',
hasAcceptedDisclosures: true,
homeAddress: {
address1: '<string>',
address2: '<string>',
address3: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>'
},
isLegallyAuthorized: true,
lastName: '<string>',
mobilePhoneNumber: '<string>',
ownershipPercentage: 123,
personalIdentificationNumber: {value: '<string>'},
signerDisclosuresAcceptedVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
workEmailAddress: '<string>'
},
businessDetails: {
address: {
address1: '<string>',
address2: '<string>',
address3: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>'
},
dbaName: '<string>',
formationDate: '2023-12-25',
legalName: '<string>',
phoneNumber: '<string>',
taxId: {value: '<string>'},
website: '<string>'
},
businessOwners: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
birthDate: '2023-12-25',
firstName: '<string>',
homeAddress: {
address1: '<string>',
address2: '<string>',
address3: '<string>',
city: '<string>',
postalCode: '<string>',
state: '<string>'
},
lastName: '<string>',
mobilePhoneNumber: '<string>',
ownershipPercentage: 123,
personalIdentificationNumber: {value: '<string>'}
}
],
individualValidationSource: '<string>',
organizationValidationSource: '<string>'
})
};
fetch('https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'applicant' => [
'authentication' => [
'password' => '<string>'
],
'birthDate' => '2023-12-25',
'disclosuresAcceptedVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityDisclosuresAcceptedVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'firstName' => '<string>',
'hasAcceptedDisclosures' => true,
'homeAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'address3' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>'
],
'isLegallyAuthorized' => true,
'lastName' => '<string>',
'mobilePhoneNumber' => '<string>',
'ownershipPercentage' => 123,
'personalIdentificationNumber' => [
'value' => '<string>'
],
'signerDisclosuresAcceptedVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'workEmailAddress' => '<string>'
],
'businessDetails' => [
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'address3' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>'
],
'dbaName' => '<string>',
'formationDate' => '2023-12-25',
'legalName' => '<string>',
'phoneNumber' => '<string>',
'taxId' => [
'value' => '<string>'
],
'website' => '<string>'
],
'businessOwners' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'birthDate' => '2023-12-25',
'firstName' => '<string>',
'homeAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'address3' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'state' => '<string>'
],
'lastName' => '<string>',
'mobilePhoneNumber' => '<string>',
'ownershipPercentage' => 123,
'personalIdentificationNumber' => [
'value' => '<string>'
]
]
],
'individualValidationSource' => '<string>',
'organizationValidationSource' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}"
payload := strings.NewReader("{\n \"applicant\": {\n \"authentication\": {\n \"password\": \"<string>\"\n },\n \"birthDate\": \"2023-12-25\",\n \"disclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"hasAcceptedDisclosures\": true,\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"isLegallyAuthorized\": true,\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n },\n \"signerDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workEmailAddress\": \"<string>\"\n },\n \"businessDetails\": {\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"dbaName\": \"<string>\",\n \"formationDate\": \"2023-12-25\",\n \"legalName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxId\": {\n \"value\": \"<string>\"\n },\n \"website\": \"<string>\"\n },\n \"businessOwners\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"birthDate\": \"2023-12-25\",\n \"firstName\": \"<string>\",\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n }\n }\n ],\n \"individualValidationSource\": \"<string>\",\n \"organizationValidationSource\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applicant\": {\n \"authentication\": {\n \"password\": \"<string>\"\n },\n \"birthDate\": \"2023-12-25\",\n \"disclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"hasAcceptedDisclosures\": true,\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"isLegallyAuthorized\": true,\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n },\n \"signerDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workEmailAddress\": \"<string>\"\n },\n \"businessDetails\": {\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"dbaName\": \"<string>\",\n \"formationDate\": \"2023-12-25\",\n \"legalName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxId\": {\n \"value\": \"<string>\"\n },\n \"website\": \"<string>\"\n },\n \"businessOwners\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"birthDate\": \"2023-12-25\",\n \"firstName\": \"<string>\",\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n }\n }\n ],\n \"individualValidationSource\": \"<string>\",\n \"organizationValidationSource\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applicant\": {\n \"authentication\": {\n \"password\": \"<string>\"\n },\n \"birthDate\": \"2023-12-25\",\n \"disclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"hasAcceptedDisclosures\": true,\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"isLegallyAuthorized\": true,\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n },\n \"signerDisclosuresAcceptedVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workEmailAddress\": \"<string>\"\n },\n \"businessDetails\": {\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"dbaName\": \"<string>\",\n \"formationDate\": \"2023-12-25\",\n \"legalName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"taxId\": {\n \"value\": \"<string>\"\n },\n \"website\": \"<string>\"\n },\n \"businessOwners\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"birthDate\": \"2023-12-25\",\n \"firstName\": \"<string>\",\n \"homeAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"lastName\": \"<string>\",\n \"mobilePhoneNumber\": \"<string>\",\n \"ownershipPercentage\": 123,\n \"personalIdentificationNumber\": {\n \"value\": \"<string>\"\n }\n }\n ],\n \"individualValidationSource\": \"<string>\",\n \"organizationValidationSource\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"applicant": {
"birthDate": "2023-12-25",
"disclosuresAcceptedAtDateTime": "2023-11-07T05:31:56Z",
"disclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"hasAcceptedDisclosures": true,
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"isLegallyAuthorized": true,
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumberLast4": "<string>",
"signerDisclosuresAcceptedVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"businessStructureType": "CORPORATION_PUBLIC",
"dbaName": "<string>",
"legalName": "<string>",
"northAmericanIndustryClassificationSystemCode": "SOYBEAN_FARMING",
"phoneNumber": "<string>",
"taxIdLast4": "<string>",
"website": "<string>"
},
"businessOwners": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"birthDate": "2023-12-25",
"firstName": "<string>",
"homeAddress": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"lastName": "<string>",
"mobilePhoneNumber": "<string>",
"ownershipPercentage": 123,
"personalIdentificationNumberLast4": "<string>"
}
],
"deniedAt": "2023-11-07T05:31:56Z",
"kycVerificationStatus": "PENDING",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "DRAFT",
"submittedAt": "2023-11-07T05:31:56Z",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "<string>",
"errorCode": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"errorCode": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Authorizations
Application (M2M) OAuth2 access token (client credentials).
FlowClient Credentials
- Token URL
- /connect/token
Scopes1
bank_account_application:write:org
Submit and manage applications to open new bank accounts within your organization.
Path Parameters
The application ID.
Body
application/jsonapplication/*+json
Request model for updating an existing bank account application. Uses
Tesouro.Common.Types.Rest.Optional<T> for partial-update semantics — see that
type for the absent / explicit-null / explicit-value contract.
Applicant details to update. Absent = preserve; explicit value = replace; explicit null = clear.
Show child attributes
Show child attributes
Business details to update. Absent = preserve; explicit value = replace; explicit null = clear.
Show child attributes
Show child attributes
List of business owners. Absent = preserve existing owners; explicit null = clear all owners. A non-empty list replaces the stored owner list; an empty array is rejected. Supply an existing owner's id to merge with the stored record; omit the id for a new owner.
Show child attributes
Show child attributes
Validation source for individual KYC (bypass-KYC partners only). Absent = preserve.
Validation source for organization KYC (bypass-KYC partners only). Absent = preserve.
Response
Application updated successfully.
Response model for a bank account application.
Unique identifier for the bank account application.
When the application was started (UTC).
When the application was last saved (UTC).
Applicant information for the bank account.
Show child attributes
Show child attributes
Business details associated with the application.
Show child attributes
Show child attributes
List of business owners associated with the application.
Show child attributes
Show child attributes
When the application was denied (UTC). Null unless the status is DENIED, and for applications denied before decline times were recorded.
Outcome of the identity/business (KYC) verification for the application, or null when verification has not started. May be non-null before submission: bypass-KYC providers have this pre-approved at creation while the application is still in DRAFT.
Available options:
PENDING, MANUAL_REVIEW, APPROVED, DENIED, DOCUMENT_VERIFICATION_REQUIRED Identifier of the organization the application has been onboarded under. Null until the application has been verified and the organization created.
Current status of the bank account application.
Available options:
DRAFT, SUBMITTED, COMPLETE, DELETED, CANCELED, DENIED When the application was submitted (UTC). Null until it is submitted, and for applications submitted before submit times were recorded.
Identifier of the user created for the applicant during onboarding. Null until the application has been verified and the user created.
Was this page helpful?