Retrieve details for a Business Account such as the account ID, name, description, industry code, and Identity Verification (IDV) status. The ID of the account’s Parent Business Account is also returned.
GET /v1/business-accounts/{businessAccountId}
Authorization: Bearer <access_token>
businessAccountId REQUIRED
string (UUID)
Provide the ID of the Business Account to retrieve. Use self to retrieve the Business Account associated with the request access token.
embed
string, values: children, limits, verification-status
Specify subresources to embed in the response. The subresources are returned in the _embedded object. The following subresources can be requested:
Use a comma-separated list to return multiple subresources (example: children,limits,verification-status).
None
Returns the Business Account object. This object contains the Business Account details.
The _embedded object contains any requested subresources, including:
SAMPLE RESPONSE
{
"id": "4f85f54f-5b01-4b3e-a31a-3217fccabe5b",
"parentId": "3bafa1d4-82a8-4e74-9ed1-25b348ebb22f",
"name": "ABC Corporation",
"description": "Business Account",
"industryCode": "007005",
"registeredStateCode": "NY",
"contacts": [
{
"firstName": "Leslie",
"middleName": "",
"lastName": "Jones",
"primary": yes,
"primaryPhoneNumber": {
"number": "15551234",
"type": "WORK",
"provider": "",
"extension": "",
"verified": no
},
"primaryEmail": {
"value": "ljones@abc.com",
"verified": no
}
}
],
"verificationStatus": {
"status": "UNVERIFIED",
"reason": "Processing",
"updatedAt": "2024-08-12T01:09:27.246Z",
"updatedBy": {
"id": "cb51cced-fb9a-43cd-abc8-c6842c871262",
"type": "employee"
}
},
"_embedded": {
"children": [
{
"id": "6257cbb4-9a7b-47fc-b7ea-c2256e8ddd2b",
"parentId": "4f85f54f-5b01-4b3e-a31a-3217fccabe5b",
"name": "XYZ Corporation",
"description": "Business Account",
"industryCode": "007005",
"verificationStatus": {
"status": "UNVERIFIED",
"reason": "Processing",
"updatedAt": "2024-08-12T01:09:27.246Z",
"updatedBy": {
"id": "cb51cced-fb9a-43cd-abc8-c6842c871262",
"type": "employee"
}
}
}
],
"limits": [
{
"businessAccountId": "4f85f54f-5b01-4b3e-a31a-3217fccabe5b",
"periods": [
{
"type": "daily",
"from": "2022-06-22T00:00:00+00:00",
"to": "2022-06-23T00:00:00+00:00",
"amount": {
"USD": {
"limit": "10000.00",
"used": "150.00"
},
"CAD": {
"limit": "15000.00",
"used": "350.00"
}
}
},
{
"type": "weekly",
"from": "2022-06-19",
"to": "2022-06-25",
"amount": {
"USD": {
"limit": "50000.00",
"used": "2150.00"
},
"CAD": {
"limit": "65000.00",
"used": "550.00"
}
}
},
{
"type": "monthly",
"from": "2022-06-01T00:00:00+00:00",
"to": "2022-07-01T00:00:00+00:00",
"amount": {
"USD": {
"limit": "200000.00",
"used": "20150.00"
},
"CAD": {
"limit": "265000.00",
"used": "17550.00"
}
}
}
]
},
{
"businessAccountId": "3bafa1d4-82a8-4e74-9ed1-25b348ebb22f",
"periods": [
{
"type": "daily",
"from": "2022-06-22T00:00:00+00:00",
"to": "2022-06-23T00:00:00+00:00",
"amount": {
"USD": {
"limit": "5000.00",
"used": "150.00"
},
"CAD": {
"limit": "5000.00",
"used": "350.00"
}
}
},
{
"type": "weekly",
"from": "2022-06-19",
"to": "2022-06-25",
"amount": {
"USD": {
"limit": "20000.00",
"used": "150.00"
},
"CAD": {
"limit": "5000.00",
"used": "50.00"
}
}
},
{
"type": "monthly",
"from": "2022-06-01T00:00:00+00:00",
"to": "2022-07-01T00:00:00+00:00",
"amount": {
"USD": {
"limit": "100000.00",
"used": "10150.00"
},
"CAD": {
"limit": "165000.00",
"used": "7550.00"
}
}
}
]
}
],
"verificationStatusHistory": [
{
"status": "UNVERIFIED",
"reason": "Processing",
"updatedAt": "2024-08-12T01:09:27.246Z",
"updatedBy": {
"id": "cb51cced-fb9a-43cd-abc8-c6842c871262",
"type": "employee"
}
}
]
}
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
