Cadastrando

Cadastrando um novo cliente

POST /v1/organization/CLIENT_ID/companies

Neste endpoint você irá cadastrar a empresa do seu cliente juntamente com 1 representante legal. Assim que o cadastro ocorre, a API faz verificações no CPF do representante legal de modo a seguir esse fluxo. Note que caso ele não tenha um BirdID válido, a API irá gerar um link de video-conferência automaticamente. Caso ele não tenha BirdID válido e não esteja habilitado a fazer a video conferência, você precisá direcionar ele para uma loja física para conseguir emitir o BirdID.

Todos os endpoints, necessitarão dos 2 tokens no Header e deverá ser passado na URL o CLIENT_ID. Esse assunto foi tratado em Primeiros Passos, caso não tenha este código, acione o time de suporte.

IMPORTANTE: Para que o seu cliente consiga fazer a emissão do certificado usando o link de Emissão Online, ele precisa ter um BirdID válido!

Headers:

Name	Value
Content-Type	application/json
Accept	application/json
Authorization	Bearer <token de Autenticação>
x-spro-authorization	<token de Autorização>

URL Parameters: exemplo: /v1/organization/CLIENT_ID/companies

Parametro	Descrição
CLIENT_ID	Código da sua empresa (passado pelo time de integração após o setup). Detalhado em: Primeiros passos.

Body:

{
    "type": "J",
    "registration_number": "23158308000165",
    "alias": "Nome da Empresa",
    "name": "Nome da Empresa",
    "phone": "[phone]",
    "whatsapp": "[phone]",
    "email": "[e-mail]",
    "country_id": "1058",
    "country_name": "Brasil",
    "state_id": "00",
    "state_name": "",
    "city_id": "00",
    "city_name": "",
    "neighborhood": "",
    "postal_code": "00000-000",
    "address": "",
    "number": "0",
    "complement": "",
    "customer": {
        "name": "Nome do Representante Legal",
        "email": "[e-mail]",
        "registration_number": "000000000000",
        "phone": "(00)00000-0000",
        "whatsapp": "(00)00000-0000"
    }
}

Detalhes dos campos

Nome	Tipo	Obrigatório	Descrição
type	string	sim	Aceito somente: J (cliente PJ) F (cliente PF)
registration_number	string	sim	CPF ou CNPJ (enviar sem formatação)
alias	string	sim	Nome da Empresa
name	string	sim	Nome da Empresa
phone	string	não	Telefone da Empresa
whatsapp	string	não	Whatsapp da Empresa
email	string	não	Email da Empresa
country_id	int	não	Código IBGE do país, no caso o código: 1058 é o código do Brasil
country_name	string	não	Nome do Pais
state_id	int	não	Código IBGE do Estado
state_name	string	não	Nome do Estado
city_id	int	não	Código IBGE da Cidade
city_name	string	não	Nome da Cidade
neighborhood	string	não	Nome do Bairro
postal_code	string	não	CEP do endereço
address	string	não	Nome da rua
number	string	não	Número do imovel
complement	string	não	Complemento
customer
name	string	sim	Nome do Representante Legal
email	string	sim	Email do Representante Legal
registration_number	string	sim	CPF do Representante Legal (passar sem formatação)
phone	string	não	Telefone do Representante Legal
whatsapp	string	não	Whatsapp do Representante Legal

Response:

201

{
"company": {
	"id": 133,
	"ulid": "01jawvcvfahk52qsaerzfa0tyj",
	"status": null,
	"type": "J",
	"registration_number": "23158308000165",
	"alias": "Nome da Empresa",
	"name": "Nome da Empresa",
	"email": "[e-mail]",
	"phone": "[phone]",
	"whatsapp": "[phone]",
	"country_id": "1058",
	"state_id": "",
	"city_id": "",
	"address": "",
	"number": "",
	"complement": "",
	"neighborhood": "",
	"postal_code": "00000-000",
	"all_customers_has_birdid": null,
	"customers": [
		{
			"id": 167,
			"ulid": "01jawvcx9v1d0kxvjzhde7w27k",
			"status": true,
			"registration_number": "00000000000",
			"name": "Nome do Representante Legal",
			"email": "[e-mail]",
			"phone": "(00)00000-0000",
			"whatsapp": "(00)00000-0000",
			"bird_id": {
				"is_valid": true,
				"verified_at": "2024-10-23 11:09:55"
			},
			"videoconference": {
				"verification": false,
				"link": null
			}
		}
	]
 }
}

401

403

404

422

Fluxo de verificação se o representante legal tem BirdID

Nos casos onde o representante legal não tem BirdID e não pode fazer video-conferencia, ele deve ser direcionado a fazer a emissão do certificado presencialmente.