Abertura de conta PJ

Abertura de conta PJ com autenticação de dois fatores (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"
            }
        ]
    }
}

Abertura de conta PJ

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"
            }
        ]
    }
}

Copiando e Colando o Payload de exemplo

Antes de iniciar os testes, as document_keys(UUIDs) dos campos company_statute e document_identification devem ser substituidas pelas chaves retornadas no upload de documentos dos titulares da conta.

Mock de CPF/CNPJ

Para simular situações de aprovação, reprovação e analise manual pode ser utilizado o primeiro digito do CPF/CNPJ do owner da conta:

0 à 7 -> Análise Manual

8 -> Reprovação Automática

9 -> Aprovação Automática

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\"}"
}

Request Body Params

Campo	Tipo	Descrição	Caracteres
account_owner *	object	Objeto Dono da conta	Objeto account_owner
allowed_user *	object	Usuário vinculado a conta.	Objeto allowed_user
account_manager	object	Dados do parceiro integrador que realizará a movimentação da conta via API.	Objeto account_manager
`signed_contract` *	object	Objeto contento as informações da assinatura do contrato.	Objeto signed_contract

Objeto account_owner

Campo	Tipo	Descrição	Caracteres
address *	object	Objeto endereço do titular da conta	Objeto address
cnae_code *	string	Classificação Nacional de Atividades Econômicas	9
company_document_number *	string	CNPJ	14
company_statute *	string	DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente).	36
company_type	enum	Tipo da empresa	Enumeradores company_type
company_representatives *	list	Lista dos representantes legais da empresa	Objeto company_representatives
email *	string	Email institucional da empresa.	254
foundation_date *	string	Data de abertura da empresa (formato "AAAA-MM-DD").	10
name *	string	Razão social.	100
person_type *	enum	Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ.	Enumeradores person_type
phone *	object	Telefone do titular da conta.	Objeto phone
trading_name *	string	Nome fantasia.	200

Objeto allowed_user

Campo	Tipo	Descrição	Caracteres
email *	string	Email do usuário da conta.	254
individual_document_number *	string	CPF do usuário da conta (apenas números).	11
name *	string	Nome do usuário da conta.	100
person_type *	enum	Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural".	Enumeradores person_type
phone	object	Telefone do usuário.	Objeto phone

Objeto account_manager

Campo	Tipo	Descrição	Caracteres
address *	object	Objeto endereço do parceiro integrador	Objeto address
cnae_code *	string	Classificação Nacional de Atividades Econômicas	9
company_document_number *	string	CNPJ	14
company_statute *	string	DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente).	36
company_type	enum	Tipo da empresa	Enumeradores company_type
company_representatives *	list	Lista dos representantes legais da empresa	Objeto company_representatives
email *	string	Email institucional da empresa.	254
foundation_date *	string	Data de abertura da empresa (formato "AAAA-MM-DD").	10
name *	string	Razão social.	100
person_type *	enum	Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ.	Enumeradores person_type
phone *	object	Telefone do parceiro integrador.	Objeto phone
trading_name *	string	Nome fantasia.	200

Objeto company_representatives

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do representante da empresa	100
address *	object	Objeto endereço do representante da empresa	Objeto address
email *	string	Email do representante da empresa	254
birth_date *	string	Data de nascimento representante da empresa (formato "AAAA-MM-DD")	10
individual_document_number *	string	CPF do representante da empresa (apenas números).	11
document_identification	string	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)	36
document_identification_number	string	Número do documento de identificação com foto da pessoa (RG ou CNH)	16
is_pep *	boolean	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).	-
marital_status	enum	Estado civil do representante da empresa	Enumeradores marital status
mother_name *	string	Nome da mãe do representante da empresa	100
nationality	string	Nacionalidade do representante da empresa	50
person_type *	enum	Identificador de que o objeto enviado é uma pessoa física	Enumeradores person_type
phone *	object	Objeto com dados do telefone do representante da empresa	Objeto phone

Objeto address

Este objeto, presente tanto no objeto PF quanto no objeto PJ, é um simples objeto para representar um endereço.

Campo	Descrição	Exemplo	Caracteres
street *	string	Rua do endereço	500
state *	enum	Estado do endereço (com dois caracteres maiúsculos)	2
city *	string	Cidade do endereço	255
neighborhood *	string	Bairro do endereço	500
number *	string	Número da rua	10
postal_code *	string	CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)	8
complement	string	Complemento do endereço (texto livre)	500

Objeto signed_contract

Campo	Tipo	Descrição	Caracteres
document_key *	uuidv4	Chave única de identificação do documento do Termo de Abertura de Conta ou Contrato de Conta Escrow. (A DOCUMENT_KEY é retornada na resposta do endpoint de Upload de documentos)	36
signatures *	list	Dados de assinatura do documento enviado. Cada item da lista, corresponde a um assinante do documento.	Objeto signatures

Objeto signatures

Campo	Tipo	Descrição	Caracteres
authenticity *	object	Conjunto de dados que evidenciam a assinatura eletrônica realizada pelo assinante.	Objeto authenticity
signer *	object	Objeto contendo os dados de um dos assinantes do documento.	Objeto signer
authentication_type *	enumerator	Tipo de assinatura. Sempre será "opt-in"	"opt-in"

Objeto authenticity

Campo	Tipo	Descrição	Caracteres
timestamp *	string	Data e hora do momento da assinatura do documento.	27
facial_recognition_key	uuidv4	Chave única de identificação da foto da selfie do titular da conta. (A DOCUMENT_KEY é retornada na resposta do endpoint de Upload de documentos)	36
lang	string	Coordenada de longitude da geolocalização do assinante capturada no momento da assinatura.	-
lat	string	Coordenada de latitude da geolocalização do assinante capturada no momento da assinatura.	-
ip_address	string	Endereço IP do dispositivo do assinante.	-
session_id	string	ID da seção do assinante no momento da assinatura.	-

Objeto signer

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do assinante.	-
email *	string	Email do assinante.	-
phone *	object	Objeto com dados do telefone do assinante	Objeto phone
document_number *	string	CPF do assinante.	11

Objeto phone

Campo	Descrição	Exemplo	Máx. Caracteres
`country_code` *	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
`area_code` *	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	2
`number` *	string	Número de telefone (apenas números)	10

Enumeradores person_type

Enum	Description
natural	Pessoa física
legal	Pessoa jurídica

Enumeradores document_identification_type

Enum	Description
rg	RG - Registro Geral
cnh	CNH - Carteira Nacional de Habilitação

Enumeradores company_type

Enum	Description
ltda	Limitada
sa	Sociedade Anônima
micro_enterprise	Micro Empresa
freelancer	Freelancer
sa_opened	Sociedade Anônima de Capital Aberto
sa_closed	Sociedade Anônima de Capital Fechado
se_ltda	Sociedade Empresária Limitada
se_cn	Sociedade Empresária em Nome Coletivo
se_cs	Sociedade Empresária em Comandita Simples
se_ca	Sociedade Empresária em Comandita por Ações
scp	Sociedade em Conta de Participação
ei	Empresário Individual
ese	Estabelecimento, no Brasil, de Sociedade Estrangeira
eeab	Estabelecimento, no Brasil, de Empresa Binacional Argentino-Brasileira
ssp	Sociedade Simples Pura
ss_ltda	Sociedade Simples Limitada
ss_cn	Sociedade Simples em Nome Coletivo
ss_cs	Sociedade Simples em Comandita Simples
eireli_ne	Empresa Individual de Responsabilidade Limitada (de Natureza Empresária)
eireli_ns	Empresa Individual de Responsabilidade Limitada (de Natureza Simples)
eireli	Empresa de Responsabilidade Individual
mei	Micro Empreendedor Individual
me	Micro Empresa
cop	Cooperativa
private_association	Sociedade Privada

Enumeradores marital_status

Enum	Description
single	Solteiro(a)
married	Casado(a)
widower	Viúvo(a)
divorced	Divorciado(a)
separated	Separado(a)

Abertura de conta PJ

Abertura de conta PJ com autenticação de dois fatores (2FA)​

Request​

Abertura de conta PJ​

Request​

Response​

Request Body Params​

Objeto account_owner​

Objeto allowed_user​

Objeto account_manager​

Objeto company_representatives​

Objeto address​

Objeto signed_contract​

Objeto signatures​

Objeto authenticity​

Objeto signer​

Objeto phone​

Enumeradores person_type​

Enumeradores document_identification_type​

Enumeradores company_type​

Enumeradores marital_status​

Abertura de conta PJ com autenticação de dois fatores (2FA)

Request

Abertura de conta PJ

Request

Response

Request Body Params

Objeto account_owner

Objeto allowed_user

Objeto account_manager

Objeto company_representatives

Objeto address

Objeto signed_contract

Objeto signatures

Objeto authenticity

Objeto signer

Objeto phone

Enumeradores person_type

Enumeradores document_identification_type

Enumeradores company_type

Enumeradores marital_status