To enable the User to operate financially in a fully regulated environment, it’s necessary to validate its personal identification. We use strategic partnerships which enable us to check the input information against a huge set of official databases such as the Receita Federal, Policia Federal, OFAC and other sanctions listings.
Personal Accounts
For signing up individual personal accounts, you'll need:
- A valid and unique e-mail address
- A valid and active CPF, matching the user data provided in the sign up (name, birthdate, etc.)
- No financial or criminal sanctions nationally or internationally
- No political exposure or relationships (PEP)
- A valid physical address matching the user data (may require additional validation)
- A valid and unique phone, verified by SMS (Check the Phone Verification guide)
- A valid identification document for upload (Check the Document Verification guide).
- A selfie with the user holding the document, for face matching and possession verification (may require additional validation)
In some special cases you might also need:
- A picture of the user handwritten signature
- A picture of a valid address statement (public services bill, phone bills, etc)
These checks are needed in the account signup, but some of them are rechecked frequently. If any account does not meet the standards after its creation, it may get blocked. In that case, you'll need to contact the Compliance team at the Help Desk.
Important!
The field
motherNameis required by default in our KYC. In some cases, the user does not have any mother registered in his document. In that case you should fill the value asDESCONHECIDO.
Payload to register a Personal Account
curl --location --request POST 'https://<<instance>>/consumers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 000000000000000' \
--data-raw '{
"password": "[email protected]",
"firstName": "Fulano",
"lastName": "de Tal",
"email": "[email protected]",
"role": "consumer", (// always consumer)
"domain": "0a49471d-1cff-4805-829b-e2409969c111", (domainID that will be registered)
"consumer": {
"type": "personal",
"taxId": "1231231223", (CPF for Brazilian registrations)
"motherName": "Mae de Fulano de Tal", (mother's name, check if it's not a maiden name)
"birthday": "1980-12-30 12:00:00", ("YYYY-MM-DD HH:mm")
"birthCity": "Vila Velha",
"birthState": "ES",
"civilStatus": "single", (single, married, widowed, divorced)
"financialProfit": "1000",
"financialEquity": "1000",
"pep": false,
"phones": [
{
"code": "11",
"number": "99988998",
"type": "mobile"
}
],
"addresses": [
{
"country": "BR",
"state": "SP",
"city": "São Paulo",
"code": "04004004", (postal code)
"street": "Av Paulista",
"number": "600",
"neighborhood": "Boa Vila",
"complement": "Ap. 30",
"reference": "",
"status": "own" (always 'own')
}
]
},
"extra":
"plan": {
"id": "b6de433b-7d88-4064-8fa5-0297dddb5ba0", (it defines the planID that this consumer will be associated in teh Billing Plan).
"prepaid": true (if prepaid billing plan)
}
}
}'
{
"password": "[email protected]",
"firstName": "Fulano",
"lastName": "de Tal",
"email": "[email protected]",
"role": "consumer", (// always consumer)
"domain": "0a49471d-1cff-4805-829b-e2409969c111", (domainID that will be registered)
"consumer": {
"type": "personal",
"taxId": "1231231223", (CPF for Brazilian registrations)
"motherName": "Mae de Fulano de Tal", (mother's name, check if it's not a maiden name)
"birthday": "1980-12-30 12:00:00", ("YYYY-MM-DD HH:mm")
"birthCity": "Vila Velha",
"birthState": "ES",
"civilStatus": "single", (single, married, widowed, divorced)
"financialProfit": "1000",
"financialEquity": "1000",
"pep": false,
"phones": [
{
"code": "11",
"number": "99988998",
"type": "mobile"
}
],
"addresses": [
{
"country": "BR",
"state": "SP",
"city": "São Paulo",
"code": "04004004", (postal code)
"street": "Av Paulista",
"number": "600",
"neighborhood": "Boa Vila",
"complement": "Ap. 30",
"reference": "",
"status": "own" (always 'own')
}
]
},
"extra":
"plan": {
"id": "b6de433b-7d88-4064-8fa5-0297dddb5ba0", (it defines the planID that this consumer will be associated in teh Billing Plan).
"prepaid": true (if prepaid billing plan)
}
}
}
For the complete properties description, checkout:
Corporate Accounts
For signing up company accounts, you'll need:
- A valid and unique e-mail address
- A valid CNPJ, matching the company data provided in the sign up (trading name, foundation date, etc.)
- A valid physical address matching the user data (may require additional validation)
- A valid and unique phone, verified by SMS (Check the Phone Verification guide)
- The legal nature of this company (see the official reference)
- The establishment format of this company: MEI, EI, EIRELI, LTDA, SS, SA, ME, EPP or EMGP.
- The annual revenue of the company, in BRL.
Additionally, all company related individuals (such as direct and indirect shareholders) must pass the Personal Verification described in the previous section, including uploading their documents. These checks are needed in the account signup, but some of them are rechecked frequently. If any account does not meet the standards after its creation, it might get blocked without any previous notice.
Payload to register a Corporate Account
// Registers a new subaccount for a consumer user
// This is create a "pending" account, after its creation
// the phone number and the user documents must be verified
const user = await bitcapital.consumers().create({
firstName: 'BIT CAPITAL',
lastName: 'LTDA',
email: '[email protected]',
password: "example",
role: 'consumer',
consumer: {
taxId: '29079725000107',
type: 'corporate',
birthday: new Date('2017-11-16'),
phones: [{
code: '11',
number: '42002480',
}],
addresses: [{
street: 'Av Nove de Julho',
number: '4939',
neighborhood: 'Jardim Paulista',
code: '01407100',
city: 'São Paulo',
state: 'SP',
country: 'BR',
status: 'own',
type: 'work',
}],
companyData: {
taxId: '29079725000107',
stateRegistration:'164677191686',
tradeName: 'Bit Capital Ltda',
legalName: 'Bit Capital Ltda',
openingDate: new Date('2017-11-16'),
establishmentFormat: 'LTDA',
revenue: "1000000.00",
partnerChanged: false,
legalNature: '2062',
legalStatus: 'active',
activities: [{
isMain: true,
code: '62.04-0-00',
description: 'Consultoria em tecnologia da informação',
}],
partners: [{
name: 'RICARDO ROESSLE GUIMARAES FILHO',
gender: 'M',
type: 'personal',
birthDate: new Date('1995-08-02'),
birthCountry: 'Brasil',
taxId: '1234567890',
motherName: 'ELISABETH GUIMARAES',
isPep: false,
profile: 'owner',
email: '[email protected]',
phones: [{
code: '11',
number: '42002480',
}],
addresses: [{
street: 'Av Nove de Julho',
number: '4939',
neighborhood: 'Jardim Paulista',
code: '01407100',
city: 'São Paulo',
state: 'SP',
country: 'BR',
status: 'own',
type: 'home',
}],
}],
},
},
});
curl --location --request POST 'https://instance-url.btcore.app/consumers' \
--header 'Authorization: Bearer 0000000000000000000000000000000000000000'\
--header 'Content-Type: application/json' \
--data-raw '{
"firstName":"BIT CAPITAL",
"lastName":"LTDA",
"email":"[email protected]",
"password": "example",
"role":"consumer",
"consumer":{
"taxId":"29079725000107",
"type":"corporate",
"birthday": "1995-08-02T12:00:00.000Z",
"phones":[{"code":"11","number":"42002480"}],
"addresses":[
{
"street":"Av Nove de Julho",
"number":"4939",
"neighborhood":"Jardim Paulista",
"code":"01407100",
"city":"São Paulo",
"state":"SP",
"country":"BR",
"status":"own"
}
],
"companyData":{
"taxId":"29079725000107",
"stateRegistration": "164677191686",
"tradeName":"Bit Capital Ltda",
"legalName":"Bit Capital Ltda",
"openingDate": "1995-08-02T12:00:00.000Z",
"establishmentFormat":"LTDA",
"revenue": 1000,
"partnerChanged":false,
"legalNature":"2062",
"activities":[
{
"isMain":true,
"code":"62.04-0-00",
"description":"Consultoria em tecnologia da informação"
}
],
"partners":[
{
"name":"RICARDO GUIMARAES FILHO",
"gender":"M",
"birthDate":{},
"birthCountry":"Brasil",
"taxId":"01234567890",
"motherName":"ELISABETH GUIMARAES",
"isPep":false,
"profile":"owner",
"email":"[email protected]",
"phones":[{"code":"11","number":"42002480"}],
"addresses":[
{
"street":"Av Paulista",
"number":"123",
"neighborhood":"Jardim Paulista",
"code":"04004000",
"city":"São Paulo",
"state":"SP",
"country":"BR",
"status":"own"
}
]
}
]
}
}
}'
For the complete properties description, checkout:
STR Extra Fields
When using BT Core with the STR Provider, usually when the BRLP - Brazilian Real (Parati) is setup in the instance, you may need to send some extra fields.
Field | Type | Description |
|---|---|---|
consumer.birthCity |
|
|
consumer.birthState |
|
|
consumer.civilStatus |
|
Available choices: |
consumer.financialEquity |
|
|
consumer.financialProfit |
|
|
SaaS Extra Fields
When using BT Core SaaS Platform, you can optionally add some other fields when creating a user related to this account:
Field | Description |
|---|---|
extra.branch |
The branch number to assign this user to. |
extra.number |
Explicitly tell which account number this consumer's first wallet should have. If not specified the system will generate a number randomly. |
Handling failed verifications
Sometimes, an account creation may be rejected by our provider's KYC or fail a validation step, which will be reflected on the consumer's status as PROVIDER_REJECTED or PROVIDER_FAILED.
To retry the account creation with updated information, the consumer update endpoint has a optional query param retry that moves back the consumer to the last non-failure status and retry it's creation.
- For updating the consumer basic information and retrying the account creation, you may use the
POST /consumers/:userId?retry=trueendpoint, sending all data to be updated as the body of the call. - For updating the consumer documents, addresses or phones, update the data using the respective endpoints and then call
POST /consumers/:userId?retry=truewith no body.
For more information, refer to the Handling failed verifications specific guides.
Updated 25 days ago
What's Next
| Phone Verification |