Properties
| Name | Type | Description |
|---|---|---|
| entity_token | string | Globally unique identifier for an entity. |
| address | object | Business''s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. |
| dba_business_name | string | Any name that the business operates under that is not its legal business name (if applicable). |
| government_id | string | Government-issued identification number. US Federal Employer Identification Numbers (EIN) are currently supported, entered as full nine-digits, with or without hyphens. |
| legal_business_name | string | Legal (formal) business name. |
| parent_company | string | Parent company name (if applicable). |
| phone_numbers | array | One or more of the business's phone number(s), entered as a list in E.164 format. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/kyb-business-entity-patch",
"title": "KYB Business Entity",
"type": "object",
"properties": {
"entity_token": {
"type": "string",
"format": "uuid",
"description": "Globally unique identifier for an entity."
},
"address": {
"$ref": "#/components/schemas/address-patch",
"description": "Business''s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable."
},
"dba_business_name": {
"description": "Any name that the business operates under that is not its legal business name (if applicable).",
"type": "string"
},
"government_id": {
"description": "Government-issued identification number. US Federal Employer Identification Numbers (EIN) are currently supported, entered as full nine-digits, with or without hyphens.",
"example": "114-123-1513",
"type": "string"
},
"legal_business_name": {
"description": "Legal (formal) business name.",
"example": "Acme, Inc.",
"type": "string"
},
"parent_company": {
"description": "Parent company name (if applicable).",
"type": "string"
},
"phone_numbers": {
"description": "One or more of the business's phone number(s), entered as a list in E.164 format.",
"items": {
"description": "Business phone number, entered in E.164 format.",
"example": "+15555555555",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"entity_token"
]
}