--- updatedAt: 2025-11-12T21:46:37.000Z agentTools: projectIndex: https://docs.getbeam.cash/llms.txt --- # Patch Business # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "beam-api-reference", "version": "3.0" }, "servers": [ { "url": "https://api.getbeam.cash" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "Authorization", "in": "header", "x-bearer-format": "bearer", "x-default": "{key}" } } }, "security": [ { "sec0": [] } ], "paths": { "/identity/cases/{caseId}/businesses/{businessId}": { "patch": { "summary": "Patch Business", "description": "", "operationId": "patch-business", "parameters": [ { "name": "caseId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "businessId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "DBA name" }, "legalName": { "type": "string" }, "description": { "type": "string" }, "taxId": { "type": "string" }, "industry": { "type": "string", "enum": [ "Agriculture", "BankingFinancialServices", "Construction", "Education", "EnergyUtilities", "EntertainmentMedia", "GovernmentPublicServices", "HealthcarePharmaceuticals", "HospitalityTourism", "InformationTechnologySoftware", "Manufacturing", "MiningResources", "NonprofitCharitableOrganizations", "RealEstate", "RetailEcommerce", "Telecommunications", "TransportationLogistics", "LegalServices", "ProfessionalServices", "Other" ] }, "phoneNumber": { "type": "string", "description": "E.164 international format" }, "email": { "type": "string" }, "website": { "type": "string" }, "registeredAddress": { "type": "object", "properties": {} }, "physicalAddress": { "type": "object", "properties": {} }, "registrationNumber": { "type": "string" }, "legalEntityType": { "type": "string", "enum": [ "CCorp", "SCorp", "LLC", "Partnership", "SoleProprietorship", "NonProfit", "GovernmentEntity" ] }, "incorporationDate": { "type": "string", "description": "yyyy-mm-dd" }, "stateOfFormation": { "type": "string" }, "countryOfFormation": { "type": "string", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "regulatoryStatus": { "type": "string", "enum": [ "USRegulated", "IntlRegulated", "NonRegulated" ] }, "regulatoryAuthority": { "type": "string" }, "regulatorJurisdiction": { "type": "string", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "regulatorRegisterNumber": { "type": "string" }, "nicCode": { "type": "string" }, "tradingType": { "type": "string", "enum": [ "Public", "Private", "PubliclyTradedSubsidiary", "Blockchain", "None", "Other" ] }, "monthlyTransactionVolume": { "type": "string" } } }, "examples": { "Request Example": { "value": { "name": null, "legalName": "Test Business LLC", "description": "Test Account", "registrationNumber": "6797434284", "taxId": "266541949", "industry": "BankingFinancialServices", "phoneNumber": "+14155558274", "email": "test@getbeam.cash", "website": null, "legalEntityType": "CCorp", "incorporationDate": "2025-08-12", "stateOfFormation": "DE", "countryOfFormation": "US", "regulatoryStatus": null, "regulatoryAuthority": null, "regulatorJurisdiction": null, "regulatorRegisterNumber": null, "nicCode": null, "tradingType": null, "monthlyTransactionVolume": null, "createdAt": "2025-08-12T19:48:43.627Z", "updatedAt": "2025-08-12T19:48:44.734Z", "registeredAddress": { "street1": "1234 Mission Street", "street2": null, "city": "San Francisco", "state": "CA", "postalCode": "94103", "country": "US" }, "physicalAddress": { "street1": "1234 Mission Street", "street2": null, "city": "San Francisco", "state": "CA", "postalCode": "94103", "country": "US" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"6e22d976-952c-42ac-884a-6894ec84dd0d\",\n \"kycUpgradeRequirements\": [\n \"'Email' must not be empty.\",\n \"'Established On' must not be empty.\",\n \"'Business Registration Number' must not be empty.\"\n ],\n \"kycLevel\": null,\n \"name\": null,\n \"legalName\": \"Test Business LLC\",\n \"description\": \"Test Account\",\n \"registrationNumber\": \"6797434284\",\n \"taxId\": \"266541949\",\n \"industry\": \"BankingFinancialServices\",\n \"phoneNumber\": \"+14155558274\",\n \"email\": \"test@getbeam.cash\",\n \"website\": null,\n \"legalEntityType\": \"CCorp\",\n \"incorporationDate\": \"2025-08-12\",\n \"stateOfFormation\": \"DE\",\n \"countryOfFormation\": \"US\",\n \"regulatoryStatus\": null,\n \"regulatoryAuthority\": null,\n \"regulatorJurisdiction\": null,\n \"regulatorRegisterNumber\": null,\n \"nicCode\": null,\n \"tradingType\": null,\n \"monthlyTransactionVolume\": null,\n \"createdAt\": \"2025-08-12T19:48:43.627Z\",\n \"updatedAt\": \"2025-08-12T19:48:44.734Z\",\n \"registeredAddress\": {\n \"street1\": \"1234 Mission Street\",\n \"street2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94103\",\n \"country\": \"US\"\n },\n \"physicalAddress\": {\n \"street1\": \"1234 Mission Street\",\n \"street2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94103\",\n \"country\": \"US\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6e22d976-952c-42ac-884a-6894ec84dd0d" }, "kycUpgradeRequirements": { "type": "array", "items": { "type": "string", "example": "'Email' must not be empty." } }, "kycLevel": {}, "name": {}, "legalName": { "type": "string", "example": "Test Business LLC" }, "description": { "type": "string", "example": "Test Account" }, "registrationNumber": { "type": "string", "example": "6797434284" }, "taxId": { "type": "string", "example": "266541949" }, "industry": { "type": "string", "example": "BankingFinancialServices" }, "phoneNumber": { "type": "string", "example": "+14155558274" }, "email": { "type": "string", "example": "test@getbeam.cash" }, "website": {}, "legalEntityType": { "type": "string", "example": "CCorp" }, "incorporationDate": { "type": "string", "example": "2025-08-12" }, "stateOfFormation": { "type": "string", "example": "DE" }, "countryOfFormation": { "type": "string", "example": "US" }, "regulatoryStatus": {}, "regulatoryAuthority": {}, "regulatorJurisdiction": {}, "regulatorRegisterNumber": {}, "nicCode": {}, "tradingType": {}, "monthlyTransactionVolume": {}, "createdAt": { "type": "string", "example": "2025-08-12T19:48:43.627Z" }, "updatedAt": { "type": "string", "example": "2025-08-12T19:48:44.734Z" }, "registeredAddress": { "type": "object", "properties": { "street1": { "type": "string", "example": "1234 Mission Street" }, "street2": {}, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "postalCode": { "type": "string", "example": "94103" }, "country": { "type": "string", "example": "US" } } }, "physicalAddress": { "type": "object", "properties": { "street1": { "type": "string", "example": "1234 Mission Street" }, "street2": {}, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "postalCode": { "type": "string", "example": "94103" }, "country": { "type": "string", "example": "US" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```