Criar Proof
Disparar para assinatura
Agora que já associamos os participantes ao documento, podemos disparar o contrato para assinatura.
POST /proofs
POST /proofsClique aqui para testar endpoint
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.
Exemplo de payload:
{
"proof": {
"contract_id": contract_id,
"ordered": false,
"engine": "standard"
}
}
Descrição do payload:
| Name | Type | Description |
|---|---|---|
| contract_id * | number | id do contrato em que deseja disparar para assinatura |
| engine * | string | mecanismo de prova que foi utilizado. Podendo ser: "standard" - assinatura eletrônica intermediada pela Contraktor "certificate" - assinatura digital utilizando certificado digital A3. |
| ordered | boolean | as assinaturas serão ordenadas por participantes? |
🚨 Os campos marcados com * são obrigatórios.
Exemplo de resposta:
{
"data": {
"deleted_at": null,
"document": {
"id": "d281db6d-896b-49b1-9bf0-d60cd29c6eb0"
},
"events": [
{
"action": "create",
"changed_field": null,
"from": null,
"id": 220495,
"inserted_at": "2024-05-21T15:44:05",
"item_type": "ProofEvent",
"proof": {
"id": 14614
},
"subject": null,
"to": null,
"user": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
}
},
{
"action": "send",
"changed_field": null,
"from": null,
"id": 220496,
"inserted_at": "2024-05-21T15:44:06",
"item_type": "ProofEvent",
"proof": {
"id": 14614
},
"subject": {
"approve_subject_change": null,
"certificate_company_document": null,
"certificate_company_name": null,
"certificate_document": null,
"certificate_email": null,
"certificate_name": null,
"company": null,
"company_document": null,
"company_name": null,
"confirmed_at": null,
"confirmed_ip_address": null,
"confirmed_user_agent": null,
"delivered_at": null,
"document": "324.005.740-90",
"email": "[email protected]",
"engine": "standard",
"id": 19548,
"inserted_at": "2024-05-21T15:44:05",
"name": "Seu nome aqui",
"notification_type": "email",
"order": 1,
"party": {
"id": 346164
},
"proof": {
"id": 14614
},
"qualification": "Contratada",
"refused_changes_at": null,
"sent_at": "2024-05-21T15:44:06.947768Z",
"updated_at": "2024-05-21T15:44:06",
"viewed_at": null,
"whatsappnum": null
},
"to": null,
"user": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
}
}
],
"id": 14614,
"inserted_at": "2024-05-21T15:44:05",
"ordered": null,
"organization": {
"id": 1199
},
"original_file": {
"download_url": url de download do arquivo,
"google_file_id": null,
"id": 199850,
"inserted_at": "2024-05-15T20:10:50",
"mime": "application/pdf",
"name": "dummy.pdf",
"preview_url": url de visualização prévia do arquivo,
"size": 13264,
"updated_at": "2024-05-15T20:10:50"
},
"packaged_file": null,
"preview_file": null,
"proof_subject_requested_changes": null,
"receipt_file": null,
"requester": {
"id": 3056
},
"signed_file": null,
"signing_file": null,
"status": "pending",
"subjects": [
{
"approve_subject_change": null,
"certificate_company_document": null,
"certificate_company_name": null,
"certificate_document": null,
"certificate_email": null,
"certificate_name": null,
"company": null,
"company_document": null,
"company_name": null,
"confirmed_at": null,
"confirmed_ip_address": null,
"confirmed_user_agent": null,
"delivered_at": null,
"document": "324.005.740-90",
"email": "[email protected]",
"engine": "standard",
"id": 19548,
"inserted_at": "2024-05-21T15:44:05",
"name": "Seu nome aqui",
"notification_type": "email",
"order": 1,
"party": {
"id": 346164
},
"proof": {
"id": 14614
},
"qualification": "Contratada",
"refused_changes_at": null,
"sent_at": null,
"updated_at": "2024-05-21T15:44:05",
"viewed_at": null,
"whatsappnum": null
}
],
"updated_at": "2024-05-21T15:44:05"
}
}
Assinatura Ordenada:
Nessa etapa do processo, podemos disparar as assinaturas de forma ordenada ou não. Caso algum participante precise ter uma ordem de prioridade maior para assinar o documento, é necessário passar o campo ordered como true.
⚠️ É necessário lembrar que caso o participante com nível de prioridade na assinatura ainda não tiver assinado, todo o restante do processo estará em stand by.
Caso o ordered for true, por defaut, os participantes associados primeiramente ao contrato, terão prioridade na assinatura do contrato. Caso queira mudar a ordem, siga o exemplo abaixo:
PUT /contracts/{contract_id}/shares/batch
PUT /contracts/{contract_id}/shares/batchExemplo de paylod:
{
"shares": [
{
"id": party_id,
"order": 2
},
{
"id": party_id,
"order": 1
}
]
}
Descrição do payload:
| Name | Type | Description |
|---|---|---|
| id | number | id do participante que deseja alterar a ordem |
| order | number | ordem de prioridade para assinatura |
Exemplo de resposta:
{
"data": [
{
"company": null,
"contract": {
"id": 176022
},
"email_viewed_at": null,
"engine": "standard",
"id": 345665,
"inserted_at": "2024-05-21T14:49:38",
"notification_type": "email",
"order": 1,
"party": {
"trade_name": null,
"address_zip_code": "36406-007",
"form": null,
"document": "136.382.516-08",
"reference": "em frente a santinha da Marechal",
"address_street": "Alameda João de Freitas",
"id": 346124,
"address_state": "MG",
"name": "Davi",
"national_id": "20017630",
"inserted_at": "2024-05-06T18:40:28",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": null,
"organization": {
"id": 1199
},
"updated_at": "2024-05-06T18:40:28",
"email": "[email protected]",
"address_complement": "Centro",
"phone": "(31) 98700-1467",
"contact_email": null,
"address_number": "25",
"marital_status": "single",
"address_neighborhood": "São Sebastião",
"state_subscription": null,
"person_type": "pf",
"contact_phone": null,
"imported_id": null,
"address_country": "Brasil",
"nationality": "Brasileiro",
"address_city": "Conselheiro Lafaiete",
"city_subscription": null,
"whatsappnum": "+55 31 98700 1467",
"profession": "Desenvolvedor de Software"
},
"qualification": "Contratante",
"signer_type": "sign",
"updated_at": "2024-05-21T15:30:06",
"viewed_at": "2024-05-21T15:30:06.511416Z"
},
{
"company": null,
"contract": {
"id": 176022
},
"email_viewed_at": null,
"engine": "standard",
"id": 345666,
"inserted_at": "2024-05-21T14:50:41",
"notification_type": "email",
"order": 2,
"party": {
"trade_name": null,
"address_zip_code": null,
"form": null,
"document": null,
"reference": null,
"address_street": null,
"id": 341249,
"address_state": null,
"name": "Davi Ferreira Neto Júnior",
"national_id": null,
"inserted_at": "2024-01-25T15:13:29",
"birth_date": null,
"contact_name": null,
"reps": null,
"organization": {
"id": 1199
},
"updated_at": "2024-01-25T15:13:29",
"email": "[email protected]",
"address_complement": null,
"phone": null,
"contact_email": null,
"address_number": null,
"marital_status": null,
"address_neighborhood": null,
"state_subscription": null,
"person_type": "pf",
"contact_phone": null,
"imported_id": null,
"address_country": "BR",
"nationality": null,
"address_city": null,
"city_subscription": null,
"whatsappnum": null,
"profession": null
},
"qualification": "Testemunha 1",
"signer_type": "sign",
"updated_at": "2024-05-21T15:30:06",
"viewed_at": "2024-05-21T14:50:48.276731Z"
}
]
}
Como fazer assinatura em ordem
Acesse nossa central de ajuda e veja o passo a passo completo:
Updated 6 months ago