投资人基本登记

此端点允许登记投资人的基本信息。

Request

ENDPOINT

/investor_management/investor

MÉTODO

POST

Request Body

Request Body

{
  "name": "Empresa Exemplo S.A.",
  "document_number": "12.345.678/0001-95",
  "trading_name": "Exemplo Comércio",
  "cnae_code": "62.02-3-00",
  "company_type": "sa",
  "foundation_date": "2000-01-01",
  "address": {
      "street": "Rua das Empresas",
      "neighborhood": "Centro",
      "number": "123",
      "postal_code": "01001-000",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 101"
  }
}

Request Body Params

字段	类型	描述	最大字符数
name *	string	公司全名。	255
document_number *	string	公司 CNPJ（格式："XX.XXX.XXX/XXXX-XX"）。	14
trading_name*	string	公司商业名称。	1023
cnae_code*	string	公司 CNAE 代码（格式："XXXXX-XXX"）。	7
company_type*	string	公司类型。	company_type 枚举
foundation_date*	string	公司成立日期（格式："YYYY-MM-DD"）。	-
address *	string	地址引用对象。	address 对象

Address 对象

字段	类型	描述	最大字符数
street *	string	公司地址街道名称。	500
neighborhood *	string	公司地址区域名称。	100
number *	string	地址门牌号。	10
postal_code *	string	邮政编码（格式"XXXXX-XXX"）。	8
city *	string	地址城市名称。	255
state *	string	州缩写（2个字符）。	2
complement	string	地址补充信息（如适用）。	100

company_type 枚举

枚举值	描述
ltda	有限责任公司
sa	股份公司
cop	合作社

Response

STATUS

201

Response Body

{
    "investor_key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Empresa Exemplo S.A.",
    "document_number": "12.345.678/0001-95",
    "status": "in_filling",
    "person_type": "legal",
    "trading_name": "Exemplo Comércio",
    "cnae_code": "62.02-3-00",
    "company_type": "sa",
    "foundation_date": "2000-01-01",
    "address": {
      "street": "Rua das Empresas",
      "neighborhood": "Centro",
      "number": "123",
      "postal_code": "01001-000",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 101"
    },
    "registration_datetime": "2023-01-01T12:00:00Z",
    "expiration_date": "2024-01-01T12:00:00Z"
  }

Response Body Params

字段	类型	描述	最大字符数
investor_key	string	投资人的唯一键（UUID）。	36
name	string	投资人全名。	255
document_number	string	投资人的 CNPJ。	14
status	string	投资人状态。	-
person_type	string	人员类型。	person_type 枚举
trading_name	string	投资人商业名称。	1023
cnae_code	string	投资人的 CNAE 代码。	7
company_type	string	公司类型。	company_type 枚举
foundation_date	string	投资人成立日期。	-
address	string	地址引用对象。	address 对象
registration_datetime	string	投资人注册日期和时间。	-
expiration_date	string	投资人到期日期。	-

person_type 枚举

枚举值	描述
legal	法人
natural	自然人