Adicionar Participante

Esse endpoint permite que você adicione uma pessoa física ou uma pessoa jurídica em nossa base de dados.

`POST` /parties

🚧
Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

⚠️ Para os endpoints que possuem payload, será necessário passar 'Content-Type': 'application/json' no headers da requisição.

Participante Pessoa Física:

Primeiramente, vamos adicionar um participante pessoa física.

Testar endpoint

Exemplo de payload:

{ 
  "party": { 
    "person_type": "pf", 
    "name": "Seu nome aqui", 
    "email": "[email protected]",
    "document": "000.000.000-00",
    "national_id": "00000000",
    "birth_date": "1997-08-28",
    "marital_status": "single",
    "nationality": "Brasileiro",
    "profession": "Dev",
    "address_zip_code": "36401-000",
    "address_street": "Av Car",
    "address_number": "25",
    "address_neighborhood": "Centro",
    "address_complement": "Complemento do endereço",
    "address_city": "Belo Horizonte",
    "address_state": "MG",
    "address_country": "Brasil",
    "reference": "Praça da liberdade",
    "phone": "(31) 99999-9999",
    "whatsappnum": "+55 31 99999 9999"
  } 
}

Descrição do payload:

Name	Type	Description
person_type *	string	pf
name *	string	nome da pessoa física
email *	string	email da pessoa física
document	string	CPF
national_id	string	RG
birth_date	string	data de nascimento
marital_status	string	solteiro - "single", casado - "married", divorciado - "divorced" viúvo - "widower"
nationality	string	nacionalidade
profession	string	profissão
address_zip_code	string	CEP
address_street	string	nome da rua
address_number	string	número da residência
address_neighborhood	string	bairro
address_complement	string	complemento do endereço
address_city	string	cidade
address_state	string	estado
address_country	string	país
reference	string	referência do endereço
phone	string	telefone da pessoa física
whatsappnum	string	whatsapp da pessoa física

🚨 Os campos marcados com * são obrigatórios.

Exemplo de resposta:

{
    "data": {
        "trade_name": null,
        "address_zip_code": "36401-000",
        "form": null,
        "document": "547.407.480-88",
        "reference": "Praça da liberdade",
        "address_street": "Av Car",
        "id": 346153,
        "address_state": "MG",
        "name": "Seu nome aqui",
        "national_id": "00000000",
        "inserted_at": "2024-05-14T15:11:52",
        "birth_date": "1997-08-28",
        "contact_name": null,
        "reps": null,
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-09T19:04:58",
            "workflows": null
        },
        "updated_at": "2024-05-14T15:11:52",
        "email": "[email protected]",
        "address_complement": "Complemento do endereço",
        "phone": "(31) 98700-1467",
        "contact_email": null,
        "address_number": "25",
        "marital_status": "single",
        "address_neighborhood": "Centro",
        "state_subscription": null,
        "person_type": "pf",
        "contact_phone": null,
        "imported_id": null,
        "address_country": "Brasil",
        "nationality": "Brasileiro",
        "address_city": "Belo Horizonte",
        "city_subscription": null,
        "whatsappnum": "+55 31 98700 1467",
        "profession": "Dev"
    }
}

⚠️ O id retornado nesse response será de suma importância para continuarmos o processo de criação do contrato.

Participante Pessoa Jurídica:

Podemos também cadastrar empresas em nossa base de dados.

Testar endpoint

Exemplo de payload:

{ 
  "party": { 
    "person_type": "pj", 
    "name": "Razão social da empresa aqui", 
    "trade_name": "Nome fantasia da empresa aqui",
    "contact_email": "[email protected]",
    "contact_name": "Nome da pessoa responsável",
    "contact_phone": "(99) 99999-9999",
    "document": "22.516.356/0001-15",
    "state_subscription": "843.774.723/9603",
    "city_subscription": "843.774.723/9603",
    "birth_date": "1997-08-28",
    "address_zip_code": "36400-000",
    "address_street": "Av Car",
    "address_number": "25",
    "address_neighborhood": "Centro",
    "address_complement": "Complemento do endereço",
    "address_city": "Belo Horizonte",
    "address_state": "MG",
    "address_country": "Brasil",
    "reference": "Praça da liberdade",
    "phone": "(99) 99999-9999",
    "whatsappnum": "+55 31 99999-9999"
  } 
}

Descrição do payload:

Name	Type	Description
person_type *	string	pj
name *	string	razão social da empresa
trade_name	string	nome fantasia da empresa
contact_email	string	email da pessoa responsável
contact_name	string	nome da pessoa responsável
contact_phone	string	telefone da pessoa responsável
document	string	CNPJ
state_subscription	string	inscrição estadual
city_subscription	string	inscrição municipal
birth_date	string	data de criação da empresa
address_zip_code	string	CEP
address_street	string	endereço da empresa
address_number	string	número do endereço
address_neighborhood	string	bairro
address_complement	string	complemento do endereço
address_city	string	cidade
address_state	string	estado
address_country	string	país
reference	string	referência do endereço
phone	string	telefone da empresa
whatsappnum	string	whatsapp da empresa

🚨 Os campos marcados com * são obrigatórios.

Exemplo de resposta:

{
    "data": {
        "trade_name": "Nome fantasia da empresa aqui",
        "address_zip_code": "36400-000",
        "form": null,
        "document": "22.516.356/0001-15",
        "reference": "Praça da liberdade",
        "address_street": "Av Car",
        "id": 346154,
        "address_state": "MG",
        "name": "Razão social da empresa aqui",
        "national_id": null,
        "inserted_at": "2024-05-14T15:27:34",
        "birth_date": "1997-08-28",
        "contact_name": "Nome da pessoa responsável",
        "reps": null,
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-09T19:04:58",
            "workflows": null
        },
        "updated_at": "2024-05-14T15:27:34",
        "email": null,
        "address_complement": "Complemento do endereço",
        "phone": "(99) 99999-9999",
        "contact_email": "[email protected]",
        "address_number": "25",
        "marital_status": null,
        "address_neighborhood": "Centro",
        "state_subscription": "843.774.723/9603",
        "person_type": "pj",
        "contact_phone": "(99) 99999-9999",
        "imported_id": null,
        "address_country": "Brasil",
        "nationality": null,
        "address_city": "Belo Horizonte",
        "city_subscription": "843.774.723/9603",
        "whatsappnum": "+55 31 99999-9999",
        "profession": null
    }
}

⚠️ O id retornado nesse response será de suma importância para continuarmos o processo de criação do contrato.

POST /parties

🚧Todos os endpoints deverão ser autenticados

Participante Pessoa Física:

Exemplo de payload:

Descrição do payload:

Exemplo de resposta:

Participante Pessoa Jurídica:

Exemplo de payload:

Descrição do payload:

Exemplo de resposta:

`POST` /parties

🚧
Todos os endpoints deverão ser autenticados