Novo Envelope
POST
/api/v1/documents
Envio de Documentos em massa#
Resposta:#
Requisição
Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.Exemplo:
Authorization: Bearer ********************Parâmetros Header
Parâmetros Bodyapplication/json
Exemplo
{
"title": "string",
"signature_type": "string",
"notification_url": "string",
"return_url": "string",
"pdfPassword": true,
"overdue_at": "string",
"signers": [
{
"name": "string",
"email": "string",
"request_document": true,
"document": {
"type": "string",
"number": "string"
},
"phone": {
"ddi": "string",
"ddd": "string",
"number": "string"
},
"validation_type": "string",
"signer_type": "string",
"requirement": "string"
}
],
"submission_type": "string",
"files": [
"string"
]
}Códigos de solicitação
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.veridca.com.br/api/v1/documents' \
--header 'client-id: {{api_client_id}}' \
--header 'client-secret: {{api_secret}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "string",
"signature_type": "string",
"notification_url": "string",
"return_url": "string",
"pdfPassword": true,
"overdue_at": "string",
"signers": [
{
"name": "string",
"email": "string",
"request_document": true,
"document": {
"type": "string",
"number": "string"
},
"phone": {
"ddi": "string",
"ddd": "string",
"number": "string"
},
"validation_type": "string",
"signer_type": "string",
"requirement": "string"
}
],
"submission_type": "string",
"files": [
"string"
]
}'Respostas
🟢201Novo Envelope
application/json
Body
Exemplo
{
"id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"title": "Novo envelope",
"message": null,
"status": "processing",
"created_at": "2024-08-19T17:58:54.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"deleted_at": null,
"signOrders": [
{
"id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"name": "João da Silva",
"email": "teste@teste.com.br",
"signed": false,
"signed_at": null,
"status": "pending"
},
{
"id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"signed": false,
"signed_at": null,
"status": "pending"
}
],
"documents": [
{
"id": "d1389c53-e122-4379-bd08-984aa074bb9d",
"title": "0fb4b415-c1dc-4c06-94d2-6f4c0d6fe53a",
"document_url": "https://veridca-contracts.s3.amazonaws.com/0fb4b415-c1dc-4c06-94d2-6f4c0d6fe53a.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQSIAJVGBGKPMLY2L%2F20240819%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240819T175856Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=ca10aa58a294ee04c17a76e60567665b70d7e9bd8d1d7358c90e97f68ea787ae",
"document_url_blockchain": null,
"status": "draft",
"status_text": "draft",
"pdf_password": null,
"message": null,
"storage_type": "on-chain",
"blockchain_type": "polygon",
"smart_contract_type": "NFT",
"documentUpdates": [
{
"id": "62a9df8a-e791-445d-93a5-7c497f3d120a",
"type": "EnvelopeSent",
"user": true,
"message": "O envelope Novo envelope (eb4c5b9a-400a-4493-8f3d-2f99fbeb1910) foi enviado.",
"notification_type": "sent",
"document_title": null,
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"user_name": "Daniel Leal",
"user_email": "daniel.leal.san@gmail.com",
"created_at": "2024-08-19 17:58:56",
"read_at": null
}
],
"signature_type": "digital",
"user": {
"id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "Daniel Leal",
"email": "daniel.leal.san@gmail.com",
"document": {
"type": "cpf",
"number": "07120188917"
},
"phone": {
"mobile": "41988555949"
}
},
"signers": [
{
"sign_order_id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"due_date": null,
"signer": {
"id": "9a34e0b5-aedc-4844-bd04-35c39f7fd620",
"contact_id": null,
"name": "João da Silva",
"email": "teste@teste.com.br",
"document": {
"type": "cpf",
"number": "12345679810"
},
"phone": {
"ddi": "55",
"ddd": "41",
"number": "99999999"
},
"validation_type": "adrc",
"type": "Assinante",
"request_document": false,
"requirement": "optional",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b"
}
},
{
"sign_order_id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"due_date": null,
"signer": {
"id": "7bfa6b24-9f57-409b-9b0e-af9022c16ca9",
"contact_id": null,
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"document": {
"type": "cpf",
"number": "12345678911"
},
"phone": {
"ddi": "55",
"ddd": "41",
"number": "99989999"
},
"validation_type": "adrc",
"type": "Assinante",
"request_document": true,
"requirement": "mandatory",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b"
}
}
],
"signOrders": [
{
"id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"name": "João da Silva",
"email": "teste@teste.com.br",
"signed": false,
"signed_at": null,
"status": "pending"
},
{
"id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"signed": false,
"signed_at": null,
"status": "pending"
}
],
"envelope_id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"envelope": {
"id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"title": "Novo envelope",
"message": null,
"status": "processing",
"created_at": "2024-08-19T17:58:54.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"deleted_at": null,
"sign_orders": [
{
"id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"document_id": "42ae9431-84a2-4bc8-b71d-1a4b7ec22b25",
"sign_token": "382d92a0ccfb691cde5831c84bad1d13",
"due_date": null,
"signed": false,
"confirmation_token": null,
"signed_at": null,
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"status": "pending",
"ordination": null,
"envelope_id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"signer": {
"id": "9a34e0b5-aedc-4844-bd04-35c39f7fd620",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "João da Silva",
"email": "teste@teste.com.br",
"document": "{\"type\":\"cpf\",\"number\":\"12345679810\"}",
"phone": "{\"ddi\":\"55\",\"ddd\":\"41\",\"number\":\"99999999\"}",
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"document_sign_order_id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"validation_type": "adrc",
"type": null,
"contact_id": null,
"request_document": false,
"requirement": "optional",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"signer_type": {
"id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"name": "Assinante",
"description": null,
"created_at": "2024-01-30T11:33:18.000000Z",
"updated_at": "2024-08-19T16:33:39.000000Z",
"user_id": null,
"editable": false,
"slug": "assinante"
}
}
},
{
"id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"document_id": "42ae9431-84a2-4bc8-b71d-1a4b7ec22b25",
"sign_token": "216c6196f28834d5f4573e2d404027d8",
"due_date": null,
"signed": false,
"confirmation_token": null,
"signed_at": null,
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"status": "pending",
"ordination": null,
"envelope_id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"signer": {
"id": "7bfa6b24-9f57-409b-9b0e-af9022c16ca9",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"document": "{\"type\":\"cpf\",\"number\":\"12345678911\"}",
"phone": "{\"ddi\":\"55\",\"ddd\":\"41\",\"number\":\"99989999\"}",
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"document_sign_order_id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"validation_type": "adrc",
"type": null,
"contact_id": null,
"request_document": true,
"requirement": "mandatory",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"signer_type": {
"id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"name": "Assinante",
"description": null,
"created_at": "2024-01-30T11:33:18.000000Z",
"updated_at": "2024-08-19T16:33:39.000000Z",
"user_id": null,
"editable": false,
"slug": "assinante"
}
}
}
],
"user": {
"id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "Daniel Leal",
"email": "daniel.leal.san@gmail.com",
"document": {
"type": "cpf",
"number": "07120188917"
},
"phone": "{\"mobile\":\"41988555949\"}",
"token": null,
"status": "active",
"created_at": "2024-08-12T18:24:15.000000Z",
"updated_at": "2024-08-15T22:47:24.000000Z",
"confirmed_at": "2024-08-12 18:25:01",
"metadata": null,
"email_verified_at": "2024-08-12T18:25:01.000000Z",
"mobile_verified_at": null,
"avatar": null,
"consents": "[{\"policy\":\"terms_and_conditions\",\"version\":\"1.0\",\"consent\":true,\"date\":\"2024-08-12 18:24:15\"},{\"policy\":\"privacy_policies\",\"version\":\"2.0\",\"consent\":true,\"date\":\"2024-08-12 18:24:15\"}]",
"address": "{\"billingSameAsHome\":true,\"home\":{\"zip\":\"82200300\",\"street\":\"Rua Reverendo Paulo Hecke\",\"number\":\"455\",\"complement\":null,\"district\":\"Ah\\u00fa\",\"city\":\"Curitiba\",\"state\":\"PR\"},\"billing\":{\"zip\":\"82200300\",\"street\":\"Rua Reverendo Paulo Hecke\",\"number\":\"455\",\"complement\":null,\"district\":\"Ah\\u00fa\",\"city\":\"Curitiba\",\"state\":\"PR\"}}",
"block_access": false,
"block_count": 0,
"token_expires_at": null,
"deleted_at": null,
"deletion_reason": null,
"created_by": "web"
}
},
"envelopeUpdates": [
{
"id": "62a9df8a-e791-445d-93a5-7c497f3d120a",
"type": "EnvelopeSent",
"user": true,
"message": "O envelope Novo envelope (eb4c5b9a-400a-4493-8f3d-2f99fbeb1910) foi enviado.",
"notification_type": "sent",
"envelope_title": "Novo envelope",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"user_name": "Daniel Leal",
"user_email": "daniel.leal.san@gmail.com",
"created_at": "2024-08-19 17:58:56",
"read_at": null
}
],
"origin": "api",
"folder_id": null,
"folder": null,
"draft_date": "2024-08-19 17:58:55",
"processing_date": null,
"updated_at": "2024-08-19 17:58:55",
"canceled_at": null,
"completed_at": null,
"created_at": "2024-08-19 17:58:55",
"overdue_at": "2024-10-08 00:00:00"
},
{
"id": "42ae9431-84a2-4bc8-b71d-1a4b7ec22b25",
"title": "335c1424-028e-4e41-8fc4-830accef7dc0",
"document_url": "https://veridca-contracts.s3.amazonaws.com/335c1424-028e-4e41-8fc4-830accef7dc0.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQSIAJVGBGKPMLY2L%2F20240819%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240819T175856Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=12a4662d08de52ed0917837bcad7470f7b65b3d30ecfd41738cf66ed41a4dffb",
"document_url_blockchain": null,
"status": "draft",
"status_text": "draft",
"pdf_password": null,
"message": null,
"storage_type": "on-chain",
"blockchain_type": "polygon",
"smart_contract_type": "NFT",
"documentUpdates": [
{
"id": "62a9df8a-e791-445d-93a5-7c497f3d120a",
"type": "EnvelopeSent",
"user": true,
"message": "O envelope Novo envelope (eb4c5b9a-400a-4493-8f3d-2f99fbeb1910) foi enviado.",
"notification_type": "sent",
"document_title": null,
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"user_name": "Daniel Leal",
"user_email": "daniel.leal.san@gmail.com",
"created_at": "2024-08-19 17:58:56",
"read_at": null
}
],
"signature_type": "digital",
"user": {
"id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "Daniel Leal",
"email": "daniel.leal.san@gmail.com",
"document": {
"type": "cpf",
"number": "07120188917"
},
"phone": {
"mobile": "41988555949"
}
},
"signers": [
{
"sign_order_id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"due_date": null,
"signer": {
"id": "9a34e0b5-aedc-4844-bd04-35c39f7fd620",
"contact_id": null,
"name": "João da Silva",
"email": "teste@teste.com.br",
"document": {
"type": "cpf",
"number": "12345679810"
},
"phone": {
"ddi": "55",
"ddd": "41",
"number": "99999999"
},
"validation_type": "adrc",
"type": "Assinante",
"request_document": false,
"requirement": "optional",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b"
}
},
{
"sign_order_id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"due_date": null,
"signer": {
"id": "7bfa6b24-9f57-409b-9b0e-af9022c16ca9",
"contact_id": null,
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"document": {
"type": "cpf",
"number": "12345678911"
},
"phone": {
"ddi": "55",
"ddd": "41",
"number": "99989999"
},
"validation_type": "adrc",
"type": "Assinante",
"request_document": true,
"requirement": "mandatory",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b"
}
}
],
"signOrders": [
{
"id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"name": "João da Silva",
"email": "teste@teste.com.br",
"signed": false,
"signed_at": null,
"status": "pending"
},
{
"id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"signed": false,
"signed_at": null,
"status": "pending"
}
],
"envelope_id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"envelope": {
"id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"title": "Novo envelope",
"message": null,
"status": "processing",
"created_at": "2024-08-19T17:58:54.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"deleted_at": null,
"sign_orders": [
{
"id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"document_id": "42ae9431-84a2-4bc8-b71d-1a4b7ec22b25",
"sign_token": "382d92a0ccfb691cde5831c84bad1d13",
"due_date": null,
"signed": false,
"confirmation_token": null,
"signed_at": null,
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"status": "pending",
"ordination": null,
"envelope_id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"signer": {
"id": "9a34e0b5-aedc-4844-bd04-35c39f7fd620",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "João da Silva",
"email": "teste@teste.com.br",
"document": "{\"type\":\"cpf\",\"number\":\"12345679810\"}",
"phone": "{\"ddi\":\"55\",\"ddd\":\"41\",\"number\":\"99999999\"}",
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"document_sign_order_id": "f1e62e73-b6fe-4fea-b725-eb44c0cd0b25",
"validation_type": "adrc",
"type": null,
"contact_id": null,
"request_document": false,
"requirement": "optional",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"signer_type": {
"id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"name": "Assinante",
"description": null,
"created_at": "2024-01-30T11:33:18.000000Z",
"updated_at": "2024-08-19T16:33:39.000000Z",
"user_id": null,
"editable": false,
"slug": "assinante"
}
}
},
{
"id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"document_id": "42ae9431-84a2-4bc8-b71d-1a4b7ec22b25",
"sign_token": "216c6196f28834d5f4573e2d404027d8",
"due_date": null,
"signed": false,
"confirmation_token": null,
"signed_at": null,
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"status": "pending",
"ordination": null,
"envelope_id": "eb4c5b9a-400a-4493-8f3d-2f99fbeb1910",
"signer": {
"id": "7bfa6b24-9f57-409b-9b0e-af9022c16ca9",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "Luna Aurora Rodrigues",
"email": "teste@gmail.com",
"document": "{\"type\":\"cpf\",\"number\":\"12345678911\"}",
"phone": "{\"ddi\":\"55\",\"ddd\":\"41\",\"number\":\"99989999\"}",
"created_at": "2024-08-19T17:58:56.000000Z",
"updated_at": "2024-08-19T17:58:56.000000Z",
"document_sign_order_id": "6b7b009e-4f26-4be1-9194-699be5439b1d",
"validation_type": "adrc",
"type": null,
"contact_id": null,
"request_document": true,
"requirement": "mandatory",
"signer_type_id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"signer_type": {
"id": "442f1a94-994f-4de4-a0d7-f79ef7fbe93b",
"name": "Assinante",
"description": null,
"created_at": "2024-01-30T11:33:18.000000Z",
"updated_at": "2024-08-19T16:33:39.000000Z",
"user_id": null,
"editable": false,
"slug": "assinante"
}
}
}
],
"user": {
"id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"name": "Daniel Leal",
"email": "daniel.leal.san@gmail.com",
"document": {
"type": "cpf",
"number": "07120188917"
},
"phone": "{\"mobile\":\"41988555949\"}",
"token": null,
"status": "active",
"created_at": "2024-08-12T18:24:15.000000Z",
"updated_at": "2024-08-15T22:47:24.000000Z",
"confirmed_at": "2024-08-12 18:25:01",
"metadata": null,
"email_verified_at": "2024-08-12T18:25:01.000000Z",
"mobile_verified_at": null,
"avatar": null,
"consents": "[{\"policy\":\"terms_and_conditions\",\"version\":\"1.0\",\"consent\":true,\"date\":\"2024-08-12 18:24:15\"},{\"policy\":\"privacy_policies\",\"version\":\"2.0\",\"consent\":true,\"date\":\"2024-08-12 18:24:15\"}]",
"address": "{\"billingSameAsHome\":true,\"home\":{\"zip\":\"82200300\",\"street\":\"Rua Reverendo Paulo Hecke\",\"number\":\"455\",\"complement\":null,\"district\":\"Ah\\u00fa\",\"city\":\"Curitiba\",\"state\":\"PR\"},\"billing\":{\"zip\":\"82200300\",\"street\":\"Rua Reverendo Paulo Hecke\",\"number\":\"455\",\"complement\":null,\"district\":\"Ah\\u00fa\",\"city\":\"Curitiba\",\"state\":\"PR\"}}",
"block_access": false,
"block_count": 0,
"token_expires_at": null,
"deleted_at": null,
"deletion_reason": null,
"created_by": "web"
}
},
"envelopeUpdates": [
{
"id": "62a9df8a-e791-445d-93a5-7c497f3d120a",
"type": "EnvelopeSent",
"user": true,
"message": "O envelope Novo envelope (eb4c5b9a-400a-4493-8f3d-2f99fbeb1910) foi enviado.",
"notification_type": "sent",
"envelope_title": "Novo envelope",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"user_name": "Daniel Leal",
"user_email": "daniel.leal.san@gmail.com",
"created_at": "2024-08-19 17:58:56",
"read_at": null
}
],
"origin": "api",
"folder_id": null,
"folder": null,
"draft_date": "2024-08-19 17:58:56",
"processing_date": null,
"updated_at": "2024-08-19 17:58:56",
"canceled_at": null,
"completed_at": null,
"created_at": "2024-08-19 17:58:56",
"overdue_at": "2024-10-08 00:00:00"
}
],
"envelopeUpdates": [
{
"id": "62a9df8a-e791-445d-93a5-7c497f3d120a",
"type": "EnvelopeSent",
"user": true,
"message": "O envelope Novo envelope (eb4c5b9a-400a-4493-8f3d-2f99fbeb1910) foi enviado.",
"notification_type": "sent",
"envelope_title": "Novo envelope",
"user_id": "bf7ca42f-32cd-49e9-b357-c5ff16b0303e",
"user_name": "Daniel Leal",
"user_email": "daniel.leal.san@gmail.com",
"created_at": "2024-08-19 17:58:56",
"read_at": null
}
]
}Modificado em 2024-08-19 18:02:07