Applications
- POSTCreate a new bank account application.
- POSTResume a bank account application by email.
- GETGet a bank account application by ID.
- PUTUpdate 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.
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.
- 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.
- 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.
- 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.
Create a new credit card application.
curl --request POST \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/credit-card-applications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicant": {
"authentication": {
"password": "<string>"
},
"birthDate": "2023-12-25",
"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,
"personalIdentificationNumber": {
"type": "SSN",
"value": "<string>"
},
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"annualBusinessRevenue": 123,
"businessStructureType": "CORPORATION_PUBLIC",
"companyType": "<string>",
"dbaName": "<string>",
"estimatedMonthlySpend": 123,
"formationDate": "2023-12-25",
"legalName": "<string>",
"northAmericanIndustryClassificationSystemCode": "SOYBEAN_FARMING",
"numberOfEmployees": 123,
"ownership": "<string>",
"phoneNumber": "<string>",
"taxId": {
"type": "EIN",
"value": "<string>"
},
"website": "<string>"
},
"businessOwners": [
{
"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,
"personalIdentificationNumber": {
"type": "SSN",
"value": "<string>"
}
}
]
}
'{
"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>"
},
"annualBusinessRevenue": 123,
"businessStructureType": "CORPORATION_PUBLIC",
"companyType": "<string>",
"dbaName": "<string>",
"estimatedMonthlySpend": 123,
"legalName": "<string>",
"northAmericanIndustryClassificationSystemCode": "SOYBEAN_FARMING",
"numberOfEmployees": 123,
"ownership": "<string>",
"phoneNumber": "<string>",
"website": "<string>"
},
"businessOwners": [
{
"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
}
],
"clientSecret": "<string>"
}Applications
Create a new credit card application.
Creates a new application to apply for an embedded credit card with optional applicant details, business details, and/or business owners.
Token types: APP | Required scopes: embedded:creditcardapplication:write
POST
/
embedded-banking
/
v1
/
credit-card-applications
Create a new credit card application.
curl --request POST \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/credit-card-applications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicant": {
"authentication": {
"password": "<string>"
},
"birthDate": "2023-12-25",
"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,
"personalIdentificationNumber": {
"type": "SSN",
"value": "<string>"
},
"workEmailAddress": "<string>"
},
"businessDetails": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"city": "<string>",
"countryCode": "AFG",
"postalCode": "<string>",
"state": "<string>"
},
"annualBusinessRevenue": 123,
"businessStructureType": "CORPORATION_PUBLIC",
"companyType": "<string>",
"dbaName": "<string>",
"estimatedMonthlySpend": 123,
"formationDate": "2023-12-25",
"legalName": "<string>",
"northAmericanIndustryClassificationSystemCode": "SOYBEAN_FARMING",
"numberOfEmployees": 123,
"ownership": "<string>",
"phoneNumber": "<string>",
"taxId": {
"type": "EIN",
"value": "<string>"
},
"website": "<string>"
},
"businessOwners": [
{
"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,
"personalIdentificationNumber": {
"type": "SSN",
"value": "<string>"
}
}
]
}
'{
"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>"
},
"annualBusinessRevenue": 123,
"businessStructureType": "CORPORATION_PUBLIC",
"companyType": "<string>",
"dbaName": "<string>",
"estimatedMonthlySpend": 123,
"legalName": "<string>",
"northAmericanIndustryClassificationSystemCode": "SOYBEAN_FARMING",
"numberOfEmployees": 123,
"ownership": "<string>",
"phoneNumber": "<string>",
"website": "<string>"
},
"businessOwners": [
{
"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
}
],
"clientSecret": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.
Body
application/jsonapplication/*+json
Request model for creating a new credit card application.
Optional applicant details for the credit card application.
Show child attributes
Show child attributes
Optional business details, including credit-card-specific underwriting fields.
Show child attributes
Show child attributes
Optional list of business owners to add to the application.
Show child attributes
Show child attributes
Response
Application created successfully.
Unique identifier for the credit card application.
Applicant information for the credit card application.
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.