Applications
- POSTCreate a new bank account application.
- POSTResume a bank account application by email.
- GETGet a bank account application by ID.
- PATCHUpdate an existing bank account application.
- POSTProcess KYC/KYB verification for a bank account application.
- POSTSubmit a bank account application for processing.
- POSTVerify an applicant's email using a verification code.
- POSTSend an email verification code to the applicant.
- POSTCreate a new credit card application.
- POSTResume a credit card application by email.
- GETGet a credit card application by ID.
- PATCHUpdate an existing credit card application.
- POSTSubmit a credit card application for processing.
- POSTVerify an applicant's email using a verification code.
- POSTSend an email verification code to the applicant.
Bank Accounts
- GETGet all bank accounts with balances.
- POSTCreate a new bank account.
- GETGet a bank account by ID.
- PATCHUpdate a bank account.
- GETGet users with access to a bank account.
- POSTGrant access to a bank account.
- DELRevoke access from a bank account.
- GETGet transactions for a bank account.
- GETGet transfers for a bank account.
Bank Account Access
Beneficial Owners
Disclosures
External Bank Accounts
- GETGets all external bank accounts for the authenticated user.
- POSTConnects a new external bank account.
- GETGets an external bank account by ID.
- DELUnlinks an external bank account.
- PATCHUpdates an external bank account.
- GETGet users with access to an external bank account.
- POSTGrant access to an external bank account.
- DELRevoke access from an external bank account.
- POSTLinks an external bank account by initiating micro-deposit verification.
- POSTValidates an external bank account using micro-deposits.
MoneyMovements
Organization
Identity
- GETLists all departments for the caller's organization.
- POSTCreates a new department in the caller's organization.
- GETGets a department by ID.
- PUTUpdates a department in the caller's organization.
- DELDeactivates a department in the caller's organization.
- POSTBulk assigns or removes users from a department.
- PUTAssigns a user to a department.
- DELRemoves a user from a department.
- GETLists all locations for the caller's organization.
- POSTCreates a new location in the caller's organization.
- GETGets a location by ID.
- PUTUpdates a location in the caller's organization.
- DELDeactivates a location in the caller's organization.
- POSTBulk assigns or removes users from a location.
- PUTAssigns a user to a location.
- DELRemoves a user from a location.
- GETLists all applications across the caller's organization hierarchy with child organization type counts.
- GETGets an application by ID, including its scopes and enabled status.
- PATCHUpdates payment rail scopes for an application.
- POSTDisables an application.
- POSTEnables an application.
- GETLists organizations that have a relationship with the caller's organization.
- POSTCreates a new organization as a child of the caller's organization.
- GETGets all organization IDs visible to the caller by traversing the hierarchy downward.
- GETGets details for a specific organization.
- PATCHUpdates an organization's fields. Only provided fields are updated; omitted fields remain unchanged.
- POSTDisables an organization by setting its deactivation timestamp.
- POSTDisables all applications for an organization.
- GETGets disabled payment rails for an organization.
- PATCHUpdates payment rail status for an organization.
- POSTEnables an organization by clearing its deactivation timestamp.
- POSTEnables all applications for an organization.
- PUTUploads a logo for an organization.
- DELDeletes a logo for an organization.
- GETGets all applications for an organization.
- GETGets settings for an organization.
- PATCHUpdates settings for an organization.
- GETLists users from the target organization and all its descendants.
- POSTCreates a new user in the specified organization.
- GETGets a single user from a downstream organization in the hierarchy.
- PATCHUpdates profile fields for a user in a downstream organization.
- POSTDisables a user by setting their status to INACTIVE.
- POSTEnables a user by setting their status to ACTIVE.
Get a bank account application by ID.
curl --request GET \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"applicant": {
"birthDate": "2023-12-25",
"disclosuresAcceptedAtDateTime": "2023-11-07T05:31:56Z",
"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,
"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>",
"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
}
]
}Applications
Get a bank account application by ID.
Retrieves a bank account application by its ID.
Token types: APP | Required scopes: embedded:bankaccountapplication:read
GET
/
embedded-banking
/
v1
/
bank-account-applications
/
{id}
Get a bank account application by ID.
curl --request GET \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-account-applications/{id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"applicant": {
"birthDate": "2023-12-25",
"disclosuresAcceptedAtDateTime": "2023-11-07T05:31:56Z",
"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,
"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>",
"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
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.tesouro.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Application (M2M) OAuth2 access token (client credentials).
Path Parameters
The application ID.
Response
Application retrieved successfully.
Response model for a bank account application.
Unique identifier for the bank account application.
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
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.