法人账户开户

双因素认证（2FA）法人账户开户

Request

ENDPOINT

/account

MÉTODO

POST

Request Body

{
	"account_owner": {
		"address": {
			"city": "Caraguatatuba",
			"complement": "complemento",
			"neighborhood": "Jaraguazinho",
			"number": "924",
			"postal_code": "11675200",
			"state": "SP",
			"street": "Praça Jorge Vitório de Souza"
		},
		"cnae_code": "4721-1/02",
		"company_statute": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
		"company_document_number": "46073462000130",
		"company_type": "ltda",
		"email": "marcos.alves@yopmail.com",
		"foundation_date": "2017-09-16",
		"name": "NOME DA EMPRESA",
		"person_type": "legal",
		"phone": {
			"area_code": "19",
			"country_code": "055",
			"number": "988888888"
		},
		"trading_name": "Pães e Doces",
		"company_representatives": [{
			"name": "Marcos Felipe Henrique Alves",
			"address": {
				"city": "Recife",
				"complement": null,
				"neighborhood": "Fundão",
				"number": "137",
				"postal_code": "52221110",
				"state": "PE",
				"street": "Rua Camapuã"
			},
			"email": "marcos.alves@yopmail.com",
			"birth_date": "1972-02-02",
			"individual_document_number": "08531309069",
			"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
			"document_identification_number": "339122924",
			"is_pep": false,
			"marital_status": "single",
			"mother_name": "Sueli Isadora Alves",
			"nationality": "Brasileira",
			"person_type": "natural",
			"phone": {
				"area_code": "88",
				"country_code": "055",
				"number": "995924634"
			}
		}]
	},
	"account_manager": {
		"address": {
			"city": "São Paulo",
			"complement": "s/c",
			"neighborhood": "Pinheiros",
			"number": "215",
			"postal_code": "05427000",
			"state": "SP",
			"street": "Rua Gilberto Sabino"
		},
		"cnae_code": "4721-1/02",
		"company_statute": "39e2bf16-26fc-4684-b4c0-97e46029e916",
		"company_document_number": "35082434000162",
		"company_type": "ltda",
		"email": "partneremail@partner.com",
		"foundation_date": "2018-09-16",
		"name": "Razão Social do Parceiro",
		"person_type": "legal",
		"phone": {
			"area_code": "11",
			"country_code": "055",
			"number": "987791122"
		},
		"trading_name": "Parceiro QI",
		"company_representatives": [{
			"name": "Nome do Socio da Empresa Parceira",
			"address": {
				"city": "São Paulo",
				"complement": null,
				"neighborhood": "Pinheiros",
				"number": "45",
				"postal_code": "04758001",
				"state": "SP",
				"street": "Rua do sócio"
			},
			"email": "nomesocio@partner.com",
			"birth_date": "1972-02-02",
			"individual_document_number": "34527070835",
			"document_identification": "ceca505b-b5ef-4e0b-ab62-a6e03d8d636a",
			"document_identification_number": "368335446",
            "document_identification_type": "rg",
			"is_pep": false,
			"marital_status": "single",
			"mother_name": "Mãe do sócio",
			"nationality": "Brasileira",
			"person_type": "natural",
			"phone": {
				"area_code": "11",
				"country_code": "055",
				"number": "915185434"
			}
		}]
	},
	"allowed_user": {
		"email": "nomegerente@partner.com",
		"individual_document_number": "34651104630",
		"name": "Luiz Alberto Da Silva",
		"person_type": "natural",
		"phone": {
			"country_code": "055",
			"area_code": "11",
			"number": "991611135"
		}
	},
	"signed_contract": {
        "document_key": "4d7f4e29-4b58-4905-9a69-b1f9215263f5",
        "signatures": [
            {
                "authenticity": {
                    "timestamp": "1970-01-01T00:00:01.080100Z",
                    "facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb",
                    "lang": "-35.8916627",
                    "lat": "-7.2226067",
                    "ip_address": "177.51.1.000",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "IVANILDO DE SENA LIMA",
                    "email": "teste@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "99999999999"
                },
                "authentication_type": "opt-in"
            }
        ]
    }
}

法人账户开户

Request

ENDPOINT

/account

MÉTODO

POST

Request Body

{
	"account_owner": {
		"address": {
			"city": "Caraguatatuba",
			"complement": "complemento",
			"neighborhood": "Jaraguazinho",
			"number": "924",
			"postal_code": "11675200",
			"state": "SP",
			"street": "Praça Jorge Vitório de Souza"
		},
		"cnae_code": "4721-1/02",
		"company_statute": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
		"company_document_number": "46073462000130",
		"company_type": "ltda",
		"email": "marcos.alves@yopmail.com",
		"foundation_date": "2017-09-16",
		"name": "NOME DA EMPRESA",
		"person_type": "legal",
		"phone": {
			"area_code": "19",
			"country_code": "055",
			"number": "988888888"
		},
		"trading_name": "Pães e Doces",
		"company_representatives": [{
			"name": "Marcos Felipe Henrique Alves",
			"address": {
				"city": "Recife",
				"complement": null,
				"neighborhood": "Fundão",
				"number": "137",
				"postal_code": "52221110",
				"state": "PE",
				"street": "Rua Camapuã"
			},
			"email": "marcos.alves@yopmail.com",
			"birth_date": "1972-02-02",
			"individual_document_number": "08531309069",
			"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
			"document_identification_number": "339122924",
			"is_pep": false,
			"marital_status": "single",
			"mother_name": "Sueli Isadora Alves",
			"nationality": "Brasileira",
			"person_type": "natural",
			"phone": {
				"area_code": "88",
				"country_code": "055",
				"number": "995924634"
			}
		}]
	},
	"account_manager": {
		"address": {
			"city": "São Paulo",
			"complement": "s/c",
			"neighborhood": "Pinheiros",
			"number": "215",
			"postal_code": "05427000",
			"state": "SP",
			"street": "Rua Gilberto Sabino"
		},
		"cnae_code": "4721-1/02",
		"company_statute": "39e2bf16-26fc-4684-b4c0-97e46029e916",
		"company_document_number": "35082434000162",
		"company_type": "ltda",
		"email": "partneremail@partner.com",
		"foundation_date": "2018-09-16",
		"name": "Razão Social do Parceiro",
		"person_type": "legal",
		"phone": {
			"area_code": "11",
			"country_code": "055",
			"number": "987791122"
		},
		"trading_name": "Parceiro QI",
		"company_representatives": [{
			"name": "Nome do Socio da Empresa Parceira",
			"address": {
				"city": "São Paulo",
				"complement": null,
				"neighborhood": "Pinheiros",
				"number": "45",
				"postal_code": "04758001",
				"state": "SP",
				"street": "Rua do sócio"
			},
			"email": "nomesocio@partner.com",
			"birth_date": "1972-02-02",
			"individual_document_number": "34527070835",
			"document_identification": "ceca505b-b5ef-4e0b-ab62-a6e03d8d636a",
			"document_identification_number": "368335446",
            "document_identification_type": "rg",
			"is_pep": false,
			"marital_status": "single",
			"mother_name": "Mãe do sócio",
			"nationality": "Brasileira",
			"person_type": "natural",
			"phone": {
				"area_code": "11",
				"country_code": "055",
				"number": "915185434"
			}
		}]
	},
	"allowed_user": {
        "email": "teste@email.com",
        "individual_document_number": "99999999999",
        "name": "Luiz Alberto ",
        "person_type": "natural",
        "phone": {
            "country_code": "055",
            "area_code": "12",
            "number": "999999999"
        }
    },
	"signed_contract": {
        "document_key": "4d7f4e29-4b58-4905-9a69-b1f9215263f5",
        "signatures": [
            {
                "authenticity": {
                    "timestamp": "1970-01-01T00:00:01.080100Z",
                    "facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb",
                    "lang": "-35.8916627",
                    "lat": "-7.2226067",
                    "ip_address": "177.51.1.000",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "IVANILDO DE SENA LIMA",
                    "email": "teste@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "99999999999"
                },
                "authentication_type": "opt-in"
            }
        ]
    }
}

复制粘贴示例载荷

开始测试之前，company_statute 和 document_identification 字段中的 document_keys（UUID）必须替换为上传账户持有人文件时返回的密钥。

CPF/CNPJ 模拟

为模拟审批、拒绝和人工审查情况，可使用账户 owner 的 CPF/CNPJ 首位数字：

0 至 7 -> 人工审查

8 -> 自动拒绝

9 -> 自动审批

Response

STATUS

200

Response Body

{
  "data": {
    "account_info": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "5283431",
      "financial_institution_code": "329"
    },
    "account_owner": {
      "document_number": "46073462000130",
      "name": "NOME DA EMPRESA"
    },
    "allowed_user": {
      "document_number": "34651104630",
      "name": "Luiz Alberto Da Silva"
    }
  },
  "event_datetime": "2023-05-05 14:48:32",
  "key": "5b5371ae-279c-4aa7-bc1c-776e01fea7cf",
  "status": "pending_kyc_analysis",
  "webhook_type": "account"
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}

请求体参数

字段	类型	描述	字符数
account_owner *	object	账户持有人对象	account_owner 对象
allowed_user *	object	关联到账户的用户	allowed_user 对象
account_manager	object	将通过 API 进行账户操作的集成合作伙伴数据	account_manager 对象
`signed_contract` *	object	包含合同签署信息的对象	signed_contract 对象

account_owner 对象

字段	类型	描述	字符数
address *	object	账户持有人地址对象	address 对象
cnae_code *	string	国家经济活动分类代码（CNAE）	9
company_document_number *	string	CNPJ	14
company_statute *	string	公司章程 PDF 的 DOCUMENT_KEY（提前上传）	36
company_type	enum	公司类型	company_type 枚举值
company_representatives *	list	公司法定代表人列表	company_representatives 对象
email *	string	公司机构电子邮箱	254
foundation_date *	string	公司成立日期（"YYYY-MM-DD" 格式）	10
name *	string	公司法定名称	100
person_type *	enum	标识所发送对象为法人，法人对象必须始终为 "legal"	person_type 枚举值
phone *	object	账户持有人电话	phone 对象
trading_name *	string	公司商号	200

allowed_user 对象

字段	类型	描述	字符数
email *	string	账户用户电子邮箱	254
individual_document_number *	string	账户用户 CPF（仅数字）	11
name *	string	账户用户姓名	100
person_type *	enum	标识所发送对象为个人，必须始终为 "natural"	person_type 枚举值
phone	object	用户电话	phone 对象

account_manager 对象

字段	类型	描述	字符数
address *	object	集成合作伙伴地址对象	address 对象
cnae_code *	string	国家经济活动分类代码（CNAE）	9
company_document_number *	string	CNPJ	14
company_statute *	string	公司章程 PDF 的 DOCUMENT_KEY（提前上传）	36
company_type	enum	公司类型	company_type 枚举值
company_representatives *	list	公司法定代表人列表	company_representatives 对象
email *	string	公司机构电子邮箱	254
foundation_date *	string	公司成立日期（"YYYY-MM-DD" 格式）	10
name *	string	公司法定名称	100
person_type *	enum	标识所发送对象为法人，法人对象必须始终为 "legal"	person_type 枚举值
phone *	object	集成合作伙伴电话	phone 对象
trading_name *	string	公司商号	200

company_representatives 对象

字段	类型	描述	字符数
name *	string	公司代表姓名	100
address *	object	公司代表地址对象	address 对象
email *	string	公司代表电子邮箱	254
birth_date *	string	公司代表出生日期（"YYYY-MM-DD" 格式）	10
individual_document_number *	string	公司代表 CPF（仅数字）	11
document_identification	string	带照片身份证件（身份证或驾照）PDF 的 DOCUMENT_KEY（提前上传）	36
document_identification_number	string	带照片身份证件号码（身份证或驾照）	16
is_pep *	boolean	声明该人是否为政治公众人物（PEP）	-
marital_status	enum	公司代表婚姻状况	marital_status 枚举值
mother_name *	string	公司代表母亲姓名	100
nationality	string	公司代表国籍	50
person_type *	enum	标识所发送对象为个人	person_type 枚举值
phone *	object	公司代表电话数据对象	phone 对象

address 对象

此对象在个人和法人对象中均存在，是用于表示地址的简单对象。

字段	描述	示例	字符数
street *	string	街道名称	500
state *	enum	州（两位大写字母）	2
city *	string	城市	255
neighborhood *	string	社区/街区	500
number *	string	门牌号	10
postal_code *	string	CEP（仅数字）	8
complement	string	地址补充说明（自由文本）	500

signed_contract 对象

字段	类型	描述	字符数
document_key *	uuidv4	开户条款或托管账户合同文件的唯一识别密钥（DOCUMENT_KEY 在上传文件端点的响应中返回）	36
signatures *	list	已发送文件的签名数据，列表中的每个项目对应一位签署人	signatures 对象

signatures 对象

字段	类型	描述	字符数
authenticity *	object	证明签署人完成电子签名的一组数据	authenticity 对象
signer *	object	包含文件某位签署人数据的对象	signer 对象
authentication_type *	enumerator	签署类型，始终为 "opt-in"	"opt-in"

authenticity 对象

字段	类型	描述	字符数
timestamp *	string	文件签署时的日期和时间	27
facial_recognition_key	uuidv4	账户持有人自拍照片的唯一识别密钥（DOCUMENT_KEY 在上传文件端点的响应中返回）	36
lang	string	签署时捕获的签署人地理定位经度坐标	-
lat	string	签署时捕获的签署人地理定位纬度坐标	-
ip_address	string	签署人设备的 IP 地址	-
session_id	string	签署时签署人的会话 ID	-

signer 对象

字段	类型	描述	字符数
name *	string	签署人姓名	-
email *	string	签署人电子邮箱	-
phone *	object	签署人电话数据对象	phone 对象
document_number *	string	签署人 CPF	11

phone 对象

字段	描述	示例	最大字符数
`country_code` *	string	电话 DDI 代码	3
`area_code` *	string	电话 DDD 代码	2
`number` *	string	电话号码（仅数字）	10

person_type 枚举值

枚举值	描述
natural	个人
legal	法人

document_identification_type 枚举值

枚举值	描述
rg	RG - 身份证
cnh	CNH - 驾照

company_type 枚举值

枚举值	描述
ltda	有限责任公司
sa	股份公司
micro_enterprise	微型企业
freelancer	自由职业者
sa_opened	上市股份公司
sa_closed	非上市股份公司
se_ltda	有限责任企业公司
se_cn	普通合伙企业公司
se_cs	有限合伙企业公司
se_ca	股份有限合伙企业公司
scp	参与账户合伙公司
ei	个体工商户
ese	外国公司在巴西的分支机构
eeab	阿根廷-巴西双边公司在巴西的分支机构
ssp	简单合伙公司
ss_ltda	有限简单合伙公司
ss_cn	普通合伙简单公司
ss_cs	有限合伙简单公司
eireli_ne	个人有限责任公司（商业性质）
eireli_ns	个人有限责任公司（简单性质）
eireli	个人责任公司
mei	个体微型企业主
me	微型企业
cop	合作社
private_association	私人协会

marital_status 枚举值

枚举值	描述
single	未婚
married	已婚
widower	丧偶
divorced	离婚
separated	分居

双因素认证（2FA）法人账户开户​

Request​

法人账户开户​

Request​

Response​

请求体参数​

account_owner 对象​

allowed_user 对象​

account_manager 对象​

company_representatives 对象​

address 对象​

signed_contract 对象​

signatures 对象​

authenticity 对象​

signer 对象​

phone 对象​

person_type 枚举值​

document_identification_type 枚举值​

company_type 枚举值​

marital_status 枚举值​

双因素认证（2FA）法人账户开户

Request

法人账户开户

Request

Response

请求体参数

account_owner 对象

allowed_user 对象

account_manager 对象

company_representatives 对象

address 对象

signed_contract 对象

signatures 对象

authenticity 对象

signer 对象

phone 对象

person_type 枚举值

document_identification_type 枚举值

company_type 枚举值

marital_status 枚举值