两步式开户

申请自由活动账户预留

Request

ENDPOINT

/account_request/checking

MÉTODO

POST

Request Body - 法人（PJ）账户持有人

{
    "account_owner": {
        "company_document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "foundation_date": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

Request Body - 自然人（PF）账户持有人

{
    "account_owner": {
        "document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "birthdate": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

申请 Escrow 账户预留

ENDPOINT

/account_request/escrow

MÉTODO

POST

Request Body - 法人（PJ）账户持有人

{
    "account_owner": {
        "company_document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "foundation_date": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

Request Body - 自然人（PF）账户持有人

{
    "account_owner": {
        "document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "birthdate": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

法人（PJ）账户持有人 Body Params

字段	类型	描述	字符数
account_owner	object	账户法人持有人的简化信息	PJ account_owner 对象 PF account_owner 对象

申请预留 PJ 的 account_owner 对象

字段	类型	描述	字符数
company_document_number *	string	账户持有人 CNPJ。	14
email *	string	公司联系邮箱。	200
foundation_date	string	公司成立日期。	10
name *	string	账户持有公司注册名称。	50

申请预留 PF 的 account_owner 对象

字段	类型	描述	字符数
document_number *	string	账户持有人 CPF。	14
email *	string	公司联系邮箱。	200
birthdate	string	出生日期。	10
name *	string	账户持有公司注册名称。	50

Response

STATUS

201

Response Body

{
    "account_info": {
        "account_branch": "0001",
        "account_digit": "3",
        "account_number": "1638634"
    },
    "account_request_key": "e48eb139-448e-43b9-9aee-df5f4b51158c",
    "account_request_status": "pending_kyc_analysis"
}

KYC 审批 Webhook

Webhook Body

{
    "data": {
        "account_info": {
            "account_digit": "3",
            "account_branch": "0001",
            "account_number": "1638634"
        },
        "account_request_key": "dc575950-dcce-48e1-99a6-5fb0ada63d86"
    },
    "event_datetime": "2022-09-02 22:39:39",
    "key": "dc575950-dcce-48e1-99a6-5fb0ada63d86",
    "status": "pending_additional_data",
    "webhook_type": "account_request.status_change"
}

account_request_status 枚举值

枚举值	描述
pending_kyc_analysis	待 KYC 审批
pending_additional_data	待补充信息
rejected	开户被拒

开立自由活动账户

Request

ENDPOINT

/account_request/ACCOUNT_REQUEST_KEY/checking

MÉTODO

PATCH

Request Body - 法人（PJ）账户持有人

{
    "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_document_number": "64669455000187",
        "company_statute": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
        "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"
                }
            }
        ]
    },
    "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.186",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "IVANILDO DE SENA LIMA",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Request Body - 自然人（PF）账户持有人

{
    "account_owner": {
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "birth_date": "1990-05-06",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "email": "ivanlima2604@gmail.com",
        "individual_document_number": "34651104630",
        "is_pep": false,
        "mother_name": "Dona Maria Mariane",
        "name": "Nome do Titular da Conta",
        "nationality": "nationality",
        "person_type": "natural",
        "phone": {
            "country_code": "055",
            "area_code": "11",
            "number": "999999999"
        },
        "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
    "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.186",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "Nome do Titular da Conta",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Response

STATUS

201

Response Body

{
    "account_key": "e48eb139-448e-43b9-9aee-df5f4b51158c"
}

ACCOUNT_KEY

account_key 将是账户的唯一识别密钥。所有与账户的交互都将通过它进行。

开立 Escrow 账户

Request

ENDPOINT

/account_request/ACCOUNT_REQUEST_KEY/escrow

MÉTODO

PATCH

Request Body - 法人（PJ）账户持有人

{
    "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_document_number": "64669455000187",
        "company_statute": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
        "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"
                }
            }
        ]
    },
    "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.186",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "IVANILDO DE SENA LIMA",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "destinations": [
        {
            "account_branch": "0001",
            "account_number": "1234567",
            "account_digit": "1",
            "document_number": "04252012000123",
            "name": "Conta do FIDC",
            "ispb_number": "32402502",
            "financial_institution_code_number": "329"
        }
    ],
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Request Body - 自然人（PF）账户持有人

{
    "account_owner": {
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "birth_date": "1990-05-06",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "email": "ivanlima2604@gmail.com",
        "individual_document_number": "34651104630",
        "is_pep": false,
        "mother_name": "Dona Maria Mariane",
        "name": "Nome do Titular da Conta",
        "nationality": "nationality",
        "person_type": "natural",
        "phone": {
            "country_code": "055",
            "area_code": "11",
            "number": "999999999"
        },
        "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
    "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.186",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "Nome do Titular da Conta",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "34651104630"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "destinations": [
        {
            "account_branch": "0001",
            "account_number": "1234567",
            "account_digit": "1",
            "document_number": "04252012000123",
            "name": "Conta do FIDC",
            "ispb_number": "32402502",
            "financial_institution_code_number": "329"
        }
    ],
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Response

STATUS

201

Response Body

{
    "account_key": "e48eb139-448e-43b9-9aee-df5f4b51158c"
}

ACCOUNT_KEY

account_key 将是账户的唯一识别密钥。所有与账户的交互都将通过它进行。

开户 Body Params

字段	类型	描述	字符数
account_owner *	object	账户持有人的完整信息	PJ account_owner 对象 PF account_owner 对象
signed_contract *	object	包含账户合同及签署方数据的对象。	signed_contract 对象
destinations **	list	已授权接收转账的目标账户列表。	destinations 对象
additional_documents	list	额外/可选文件 ID 列表。	UUID 数组

(**) Escrow 账户必填

开户 PJ 的 account_owner 对象

字段	类型	描述	字符数
address *	object	账户持有人地址对象	address 对象
cnae_code *	string	全国经济活动分类代码	9
company_document_number *	string	CNPJ	14
company_statute *	uuidv4	公司章程 PDF 的 DOCUMENT_KEY（预先发送）。	36
company_type *	enumerator	公司类型	company_type 枚举值
email *	string	公司机构邮箱。	200
foundation_date *	string	公司成立日期（格式"YYYY-MM-DD"）。	10
name *	string	账户持有公司注册名称。	50
person_type *	enumerator	发送对象为法人的标识符。PJ 对象必须始终包含值"legal"。	person_type 枚举值
phone *	object	账户持有人电话。	phone 对象
trading_name *	string	商业名称（商号）。	200
company_representatives *	list	公司法定代表人列表	company_representatives 对象

开户 PF 的 account_owner 对象

字段	类型	描述	字符数
address	string	账户持有人地址对象	address 对象
birth_date *	string	出生日期（格式"YYYY-MM-DD"）	-
document_identification *	uuidv4	附有照片的身份证件（RG 或 CNH）PDF 的 DOCUMENT_KEY（预先发送）	36
email *	string	账户持有人邮箱。	200
individual_document_number *	string	CPF（仅数字）。	11
is_pep *	boolean	声明该人是否为 PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep)。	-
mother_name *	string	账户持有人母亲姓名。	-
name *	string	账户持有人姓名。	-
nationality *	string	客户国籍。	-
person_type *	string	发送对象为自然人的标识符。PF 对象必须始终包含值"natural"。	person_type 枚举值
phone	string	包含账户持有人电话数据的对象	36
proof_of_residence	uuidv4	所填地址的居住证明 PDF 的 DOCUMENT_KEY（预先发送）。

address 对象

字段	描述	示例	字符数
street *	string	街道名称	500
state *	enum	州代码（两位大写字母）	2
city *	string	城市名称	255
neighborhood *	string	街区/社区名称	500
number *	string	门牌号	10
postal_code *	string	邮政编码 (http://www.buscacep.correios.com.br/sistemas/buscacep/)（仅数字）	8
complement	string	地址补充信息（自由文本）	500

phone 对象

字段	描述	示例	字符数
country_code *	string	国际区号 (https://ddi.guiamais.com.br/)	3
area_code *	string	区号 (https://ddd.guiamais.com.br/)	3
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	私人协会
association	协会
others	其他

marital_status 枚举值

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

申请自由活动账户预留​

Request​

申请 Escrow 账户预留​

法人（PJ）账户持有人 Body Params​

申请预留 PJ 的 account_owner 对象​

申请预留 PF 的 account_owner 对象​

Response​

KYC 审批 Webhook​

account_request_status 枚举值​

开立自由活动账户​

Request​

Response​

开立 Escrow 账户​

Request​

Response​

开户 Body Params​

开户 PJ 的 account_owner 对象​

开户 PF 的 account_owner 对象​

address 对象​

phone 对象​

person_type 枚举值​

document_identification_type 枚举值​

company_type 枚举值​

marital_status 枚举值​

申请自由活动账户预留

Request

申请 Escrow 账户预留

法人（PJ）账户持有人 Body Params

申请预留 PJ 的 account_owner 对象

申请预留 PF 的 account_owner 对象

Response

KYC 审批 Webhook

account_request_status 枚举值

开立自由活动账户

Request

Response

开立 Escrow 账户

Request

Response

开户 Body Params

开户 PJ 的 account_owner 对象

开户 PF 的 account_owner 对象

address 对象

phone 对象

person_type 枚举值

document_identification_type 枚举值

company_type 枚举值

marital_status 枚举值