Adicionar Participante ao Contrato
Após a criação do contrato, podemos incluir os participantes ao mesmo.
POST /contracts/{contract_id}/shares
POST /contracts/{contract_id}/sharesTodos os endpoints deverão ser autenticados
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
⚠️ Lembre-se de substituir a variável {contract_id} no parâmetro da rota pelo valor id do contrato que você deseja associar os participantes.
Participante Pessoa Física:
É possível associar uma pessoa física ou uma empresa ao contrato antes do disparo para assinatura. Caso queira adicionar um representante pessoa física ao documento, esse é o processo:
Exemplo de payload:
{
"sharing": {
"qualification": "Contratado",
"party_id": party_id,
"notification_type": "email"
}
}
Descrição do payload:
| Name | Type | Description |
|---|---|---|
| qualification * | string | qualificação do participante em relação ao contrato (ex: "Testemunha", "Contratante", "Contratado", etc...) |
| party_id * | number | id do participante pessoa física |
| notification_type * | string | tipo de notificação: email - "email" whatsapp - “whatsapp” (só será possível caso a organização tenha cotas de whatsapp contratada) |
🚨 Os campos marcados com * são obrigatórios.
Exemplo de resposta:
{
"data": {
"company": null,
"contract": {
"id": 176022
},
"email_viewed_at": null,
"engine": "standard",
"id": 345642,
"inserted_at": "2024-05-15T20:12:31",
"notification_type": "email",
"order": 1,
"party": {
"trade_name": null,
"address_zip_code": "36401-000",
"form": null,
"document": "324.005.740-90",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346164,
"address_state": "MG",
"name": "Seu nome aqui",
"national_id": "00000000",
"inserted_at": "2024-05-15T20:12:14",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": null,
"organization": {
"id": 1199
},
"updated_at": "2024-05-15T20:12:14",
"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"
},
"qualification": "Contratado",
"signer_type": "sign",
"updated_at": "2024-05-15T20:12:31",
"viewed_at": null
}
}
| Name | Description |
|---|---|
| sharing_id | 345642 |
⚠️ No exemplo acima, o valor de 345642, refere-se ao sharing_id desse usuário, esse valor será importante para alguns próximos passos do nosso fluxo.
Participante Pessoa Jurídica:
É possível associar empresas ao contrato. O processo é bem semelhante ao anterior, contudo, é obrigatório indicar um participante pessoa física responsável legal pela empresa em questão.
Exemplo de payload:
{
"sharing": {
"qualification": "Contratante",
"party_id": party_id,
"company_id": company_id,
"notification_type": "email"
}
}
Descrição do payload:
| Name | Type | Description |
|---|---|---|
| qualification * | string | qualificação do participante em relação ao contrato (ex: "Testemunha", "Contratante", "Contratado", etc...) |
| party_id * | number | id do participante pessoa física responsável legal da empresa em questão. |
| company_id * | number | id da empresa associada ao contrato. |
| notification_type* | string | tipo de notificação: email - "email" whatsapp - “whatsapp” (só será possível caso a organização tenha cotas de whatsapp contratada) |
Exemplo de resposta:
{
"data": {
"company": {
"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": 346165,
"address_state": "MG",
"name": "Razão social da empresa aqui",
"national_id": null,
"inserted_at": "2024-05-15T20:19:47",
"birth_date": "1997-08-28",
"contact_name": "Nome da pessoa responsável",
"reps": [
{
"trade_name": null,
"address_zip_code": "36401-000",
"form": null,
"document": "324.005.740-90",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346164,
"address_state": "MG",
"name": "Seu nome aqui",
"national_id": "00000000",
"inserted_at": "2024-05-15T20:12:14",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": null,
"organization": {
"id": 1199
},
"updated_at": "2024-05-15T20:12:14",
"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"
}
],
"organization": {
"id": 1199
},
"updated_at": "2024-05-15T20:19:47",
"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
},
"contract": {
"id": 176022
},
"email_viewed_at": null,
"engine": "standard",
"id": 345643,
"inserted_at": "2024-05-15T20:20:06",
"notification_type": "email",
"order": 2,
"party": {
"trade_name": null,
"address_zip_code": "36401-000",
"form": null,
"document": "324.005.740-90",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346164,
"address_state": "MG",
"name": "Seu nome aqui",
"national_id": "00000000",
"inserted_at": "2024-05-15T20:12:14",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": null,
"organization": {
"id": 1199
},
"updated_at": "2024-05-15T20:12:14",
"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"
},
"qualification": "Contratante",
"signer_type": "sign",
"updated_at": "2024-05-15T20:20:06",
"viewed_at": null
}
}
Updated 2 months ago