> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md # Get a business GET https://api-sandbox.payabli.com/api/v2/businesses/{businessReference} Retrieves a business by reference. Sensitive fields such as `taxReference` are masked. Reference: https://docs.payabli.com/developers/api-reference/businesses/get-a-business ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api-sandbox.payabli.com/api` (Sandbox, default) - `https://api.payabli.com/api` (Production) ## Request ### Path parameters - `businessReference` (string, required) — The business reference (`businessUuid`). ## Response ### 200 The business. - `success` (boolean, required) — Whether the request succeeded. - `message` (string, required, nullable) — A human-readable result message. - `traceId` (string, required, nullable) — The trace identifier for the request, useful for support. - `data` (BusinessDetailResponse, required, nullable) — The business detail. - `warnings` (list of BoardingWarning, required, nullable) — Non-blocking warnings. ## Errors ### 401 Unauthorized Error Unauthorized request. - `isSuccess` (boolean, required) — Always `false` for error responses. - `responseText` (string, required) — Error text describing what went wrong. - `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses). - `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context. ### 404 Not Found Error The requested resource wasn't found. - `isSuccess` (boolean, required) — Always `false` for error responses. - `responseText` (string, required) — Error text describing what went wrong. - `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses). - `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context. ### 500 Internal Server Error Internal server error. - `isSuccess` (boolean, required) — Always `false` for error responses. - `responseText` (string, required) — Error text describing what went wrong. - `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses). - `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context. ## Types ### BusinessDetailResponse The full detail of a business. Sensitive fields are masked unless read from the unmasked endpoint. - `businessUuid` (string, required) — The business reference. - `legalName` (string, required, nullable) — The registered legal name of the business. - `legalStructure` (enum, required) — The business's legal structure, normalized to a canonical value on read. - Allowed values: `LimitedLiabilityCompany`, `Corporation`, `Partnership`, `SoleProprietorship`, `NonProfit`, `Government`, `SCorporation` - `incorporationState` (string, required, nullable) — The state where the business is incorporated. - `taxIdCountry` (string, required, nullable) — The country that issued the business's tax identifier. - `taxExemptClassification` (string, required, nullable) — The business's tax-exempt classification, such as `501(c)(3)`. - `license` (string, required, nullable) — The business's license number. - `licenseState` (string, required, nullable) — The state that issued the business's license. - `taxReference` (string, required, nullable) — The business tax identifier. Masked on standard reads (only the last four digits are shown, for example `****8993`); read the unmasked endpoint for the raw value. - `businessStatus` (string, required) — The business's current status. - `parentReference` (string, required, nullable) — The organization entrypoint the business belongs to. - `createdAt` (datetime, required) — When the business was created. - `lastUpdated` (datetime, required) — When the business was last updated. - `_links` (BusinessLinks, required) — Hypermedia links for the business resource. - `externalId` (string, optional, nullable) — Your own identifier for the business. - `description` (string, optional, nullable) — A free-text description of the business. - `stockSymbol` (string, optional, nullable) — The stock ticker symbol, if publicly traded. - `establishedDate` (datetime, optional, nullable) — The date the business was established. - `numberOfEmployees` (integer, optional, nullable) — The number of employees. - `annualRevenue` (double, optional, nullable) — The business's annual revenue. - `website` (string, optional, nullable) — The business's website URL. - `merchantCatCode` (string, optional, nullable) — The merchant category code (MCC). - `timezone` (string, optional, nullable) — The business's time zone. - `phone` (list of string, optional, nullable) — Phone numbers for the business. - `emails` (list of string, optional, nullable) — Email addresses for the business. - `operatingSeasons` (list of enum, optional, nullable) — The seasons the business operates in. Values are case-insensitive on input and returned capitalized. - Allowed values: `Spring`, `Summer`, `Fall`, `Winter` - `addressDetails` (list of BusinessAddress, optional, nullable) — The business's addresses. - `paymentMethods` (list of BusinessPaymentMethod, optional, nullable) — The bank accounts and cards attached to the business. - `customData` (map from string to any, optional, nullable) — Arbitrary key-value data attached to the business. When present, `templateAnswers` holds the applicant's answers to a boarding template's business-level custom questions, meaning questions whose field path doesn't start with `person.`. It's an object keyed by each question's field path, such as `business.custom_referralSource`, and each answer is a string. A multi-select answer is one comma-separated string, such as `quickbooks,stripe`. Payabli saves the answers when an application is submitted through the hosted boarding application. Submitting an application with the API (`POST /v2/requests/{requestsReference}/submit`) doesn't save them. Only answers to custom questions are saved, and blank answers, standard-field answers, and document uploads aren't. A later hosted submit replaces the answer to the same question and keeps every other answer, including answers from other applications. Leaving a question blank on a later submit doesn't remove the stored answer. - `isForeignOwned` (boolean, optional, nullable) — Whether the business is foreign-owned. - `isTaxExempt` (boolean, optional, nullable) — Whether the business is tax-exempt. - `processingMetrics` (ProcessingMetrics, optional, nullable) — Expected Pay In processing profile. - `payoutMetrics` (PayoutMetrics, optional, nullable) — Expected Pay Out profile. - `certificationDetails` (list of CertificationDetail, optional, nullable) — Certifications held by the business. ### BoardingWarning A non-blocking warning returned alongside a successful response. - `code` (string, optional) — A machine-readable warning code. - `message` (string, optional) — A human-readable description of the warning. ### PayabliErrorBodyResponseData Object with detailed error context. - `explanation` (string, optional) — Human-readable explanation of what happened. - `todoAction` (string, optional) — Suggested resolution. ### BusinessLinks Hypermedia links for a business resource. - `self` (string, optional) — Relative path to the business resource. ### BusinessAddress An address associated with a business. - `type` (enum, optional) — The address role. - Allowed values: `legal`, `billing`, `shipping`, `remittance`, `physical`, `mailing` - `location` (enum, optional) — The physical use of the address. Defaults to `other`. - Allowed values: `office`, `warehouse`, `retail`, `home`, `other` - `addressLine1` (string, optional) — The first line of the street address. - `addressLine2` (string, optional) — The second line of the street address. - `cityLocality` (string, optional) — The city or locality. - `stateProvince` (string, optional) — The state or province. - `postalCode` (string, optional) — The postal or ZIP code. - `country` (string, optional) — The two-character ISO country code. - `floor` (string, optional) — The floor, if applicable. - `suiteApartNumber` (string, optional) — The suite or apartment number, if applicable. ### BusinessPaymentMethod A bank account or card attached to a business. - `type` (string, optional) — The payment method type, for example a bank account or card. - `accountOwner` (string, optional) — The name of the account owner. - `name` (string, optional) — An optional label for the payment method. - `financialInstitution` (string, optional) — The bank or financial institution that holds the account. - `ownerType` (string, optional) — Whether the owner is a business or an individual. - `accountType` (string, optional) — The account type, for example checking or savings. - `accountNumber` (string, optional) — The bank account number. - `routingNumber` (string, optional) — The bank routing number. - `cardNumber` (string, optional) — The card number, for card payment methods. - `expirationDate` (string, optional) — The card expiration date, for card payment methods. - `cvv` (string, optional) — The card verification value, for card payment methods. - `cardType` (string, optional) — The card type, for card payment methods. - `usage` (list of string, optional) — What the payment method is used for. - `isDefault` (boolean, optional) — Whether this is the owner's default payment method. At most one payment method per owner can set `isDefault` to `true`; sending two `true` values in one request fails validation. ### ProcessingMetrics Expected Pay In processing profile for the business. - `monthlyReceivablesVolume` (double, optional) — Expected monthly Pay In volume. - `averageReceivableSize` (double, optional) — Expected average transaction amount. - `largestReceivableSize` (double, optional) — Expected largest transaction amount. - `inboundPresentPercent` (integer, optional) — Percent of volume from card-present transactions. - `inboundOnlinePercent` (integer, optional) — Percent of volume from online transactions. - `inboundMotoPercent` (integer, optional) — Percent of volume from mail-order/telephone-order transactions. - `refundPolicy` (string, optional) — The business's refund policy. - `advancedDelivery` (boolean, optional) — Whether the business delivers goods or services before it's paid. - `percentAdvancedDelivery` (integer, optional) — Percent of sales delivered before payment. - `advancedDeliveryDays` (double, optional) — Average number of days between payment and delivery. - `numberOfTransactions` (integer, optional) — Expected number of transactions per month. ### PayoutMetrics Expected Pay Out profile for the business. - `monthlyPayablesVolume` (double, optional) — Expected monthly Pay Out volume. - `averagePayablesSize` (double, optional) — Expected average payout amount. - `largestPayablesSize` (double, optional) — Expected largest payout amount. - `numberOfTransactions` (integer, optional) — Expected number of payouts per month. ### CertificationDetail A certification held by the business. - `certificationType` (string, optional) — The type of certification. - `issuer` (string, optional) — The organization that issued the certification. - `certificateNumber` (string, optional) — The certificate identifier. - `issuedDate` (date, optional) — The date the certification was issued. - `expirationDate` (date, optional) — The date the certification expires. ## Examples **Response** ```json { "success": true, "message": "Business retrieved successfully", "traceId": "0HNNKQIN7BJO3:00000008", "data": { "businessUuid": "019fed1a-3d6e-75d3-a81e-cba3874b0a55", "legalName": "Rose Gardens LLC", "legalStructure": "LimitedLiabilityCompany", "incorporationState": "GA", "taxIdCountry": "US", "taxExemptClassification": null, "license": "LIC-48213", "licenseState": "GA", "taxReference": "****8993", "businessStatus": "Draft", "parentReference": "8cfec329267", "createdAt": "2026-08-10T19:15:47.694655", "lastUpdated": "2026-08-10T19:15:47.694655", "_links": { "self": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55" }, "externalId": "rg-001", "website": "https://example.com", "merchantCatCode": "5814", "phone": [ "3055551212" ], "emails": [ "ops@example.com" ], "addressDetails": [], "paymentMethods": [ { "type": "bank_account", "name": "Operating account", "financialInstitution": "Bank of Example", "ownerType": "business", "accountType": "checking", "accountNumber": "****6789", "routingNumber": "****0021", "usage": [ "deposits", "billing" ], "isDefault": true }, { "type": "bank_account", "name": "Payout account", "financialInstitution": "Bank of Example", "ownerType": "business", "accountType": "checking", "accountNumber": "****4321", "routingNumber": "****0021", "usage": [ "payOutFunding" ], "isDefault": false } ], "isTaxExempt": false, "certificationDetails": [] } } ``` **SDK Code** ```python import requests url = "https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```