Manual CertifiQI

Request

ENDPOINT

/document

METHOD

POST

Request Body

{
        "file_name": "nome.pdf",
        "document_type": "ccb",
        "document_identifier": "jfkjkd",
        "endorsement_page": true,
        "endorser_name": "NOME ENDOSSANTE",
        "endorser_document_number": "CNPM ENDOSSANTE",
        "receiver_name": "NOME ENDOSSATÁRIO",
        "receiver_document_number": "CNPJ ENDOSSATÁRIO",
        "control_number": "123456789"
}

O método POST /document deve ser utilizado para enviar os documentos (PDF ou CNAB) e vincular a um grupo de documentos.

Deverão ser enviados os seguintes dados no form-data da request:

• file - documento no formato pdf.

Retorno desta request

O retorno desta request deverá ser enviado posteriormente na request POST /batch_group. Depois de enviado junto com o batch_group não há necessidade de salvar esta informação.

Response

STATUS

200

Response Body

{
		"control_number": null,
		"document_key": "45e781b8-7275-48e6-8719-b4d232b2828a",
		"file_size": 281195,
		"name": "ml1258-00822_22_carlos_cesar_consolaro_20221222095624158505.pdf",
		"url": "https://storage.googleapis.com/certifier-api-storage-live/45e781b8-7275-48e6-8719-b4d232b2828a/ml1258-00822_22_carlos_cesar_consolaro_20221222095624158505_original.pdf"
}

Definições

Object Request Body

Campo	Tipo	Descrição	Máx. Caract.
file_name *	string	Nome do arquivo que será enviado.	-
document_type *	string	Tipo do documento que será enviado.	-
document_identifier *	string	Identificador do documento do sistema do parceiro.	-
endorsement_page *	booleano	Indica se um endosso deve ser gerado para o documento.	-
endorser_name *	string	nome do endossante.	-
endorser_document_number *	string	Numero de documento do endossante.	-
receiver_name *	string	Nome do recebedor.	-
receiver_document_number *	string	Número de documento do recebedor.	-
control_number	string	Campo opcional indicando o numero de controle da cessão, fornecido pela QI Tech quando a cessão é realizada pela pela mesma.	36

Request

ENDPOINT

/batch_group

METHOD

POST

Request Body

{
    "client_key": "eb4d4f62-f209-47aa-bb99-24d4e056ae11",
    "name": "Endosso",
    "main_related_party": "MACACO LOCO LTDA",
    "batches": [{
        "documents": [
                {
		"control_number": null,
		"document_key": "45e781b8-7275-48e6-8719-b4d232b2828a",
		"file_size": 281195,
		"name": "ml1258-00822_22_macaco_loco_20221222095624158505.pdf",
		"url": "https://storage.googleapis.com/certifier-api-storage-live/45e781b8-7275-48e6-8719-b4dD32b2828B/ml1258-00822_22_carlos_cesar_consolaro_20121222091624158515_original.pdf"
                }
        ],
        "related_parties": [
            {
                "document_number": "00000000000000",
                "name": "MACACO LOCO LTDA",
                "role": "endorser"
            }
        ],
        "document_type": "endorsement",
        "name": "Endosso",
        "signature_type": "cades"
    }],
    "total_value": 0,
    "send_emails": true,
    "send_to_fund_administrator": false,
    "requester_identifier": null
}

O método POST /batch_group deve ser utilizado para enviar todos os documentos e os assinantes do evento para assinatura. Os dados que devem ser enviados no body da request estão disponíveis em Criar 'batch group.

Response

STATUS

200

Response Body

{
	"batch_group_key": "6ab44a69-7089-4951-a27a-d58c4136ac11",
	"name": "Endosso",
	"main_related_party": "MACACO LOCO LTDA",
	"number_of_documents": 131,
	"total_value": 0.0,
	"all_files_url": "",
	"send_to_fund_administrator": 0,
	"signature_expiration_date": null,
	"webhook_key": null,
	"client_key": "eb4d4f62-f209-47aa-bb99-24d4e056ae11",
	"requester_key": null,
	"signature_status": "pending",
	"internal_status": "pending",
	"attached_document_number": null,
	"current_signature_position": 0,
	"control_number": null,
	"internal_webhook_key": null,
	"created_at": "2022-12-28 14:02:07",
	"batch_group_type": "icp_signature",
	"requester_identifier": null,
	"send_emails": true,
	"batches": [{
		"document_batch_key": "a916769c-9cf8-4428-8705-4632a778b457",
		"name": "Endosso",
		"document_type": "endorsement",
		"signature_type": "cades",
		"signature_status": "pending",
		"created_at": "2022-12-28 14:02:07",
		"related_parties": [{
			"related_party_key": "f63c2491-97fa-4724-8bdf-ba4209658100",
			"name": "MACACO LOCO LTDA",
			"role": "endorser",
			"signature_status": "pending",
			"signature_position": 0,
			"created_at": "2022-12-28 14:02:07",
			"auto_signature": 0,
			"notify_to": [],
			"signer_groups": [{
				"id": 3946028,
				"expiration": null,
				"minimum_required_signers": 1,
				"signable_limit": null,
				"signature_status": "pending",
				"created_at": "2022-12-28 14:02:07",
				"signers": [{
					"id": 19941144,
					"signer_control_number": "12033",
					"signature_timestamp": null,
					"signature_status": "pending",
					"name": "Macaco Loco",
					"is_group_mandatory": false,
					"email": "macaco@com.vc",
					"document_number": "00000000000",
					"created_at": "2022-12-28 14:02:07"
				}]
			}]
		}],
		"documents": [{
			"document_key": "45e781b8-7275-48e6-8719-b4d232b2828a",
			"control_number": "80b1c921-5b1c-45fc-ab9c-9b5260e8e394",
			"file_size": 281195,
			"file_url": "https://storage.googleapis.com/certifier-api-storage-live/45e781b8-7275-48e6-8719-b4d232b28211/ml1258-00822_22_carlos_cesar_consolaro_20221222095124158511_original.pdf",
			"name": "ml1258-00822_22_macaco_loco_20221222095624158511.pdf",
			"original_file_url": "https://storage.googleapis.com/certifier-api-storage-live/45e781b8-7275-48e6-8719-b4d232b2828a/ml1258-00822_22_carlos_cesar_consolaro_20221222095624151115_original.pdf",
			"status": "pending",
			"signed_file_url": null,
			"created_at": "2022-12-28 14:02:07",
			"signatures": []
		}]
	}],
	"watcher_clients": []
}

Definições

Object Request Body

Campo	Tipo	Descrição	Máx. Caract.
client_key *	string	uuid representando a chave do parceiro.	-
name *	string	Nome dado ao grupo de documentos que será enviado.	-
main_related_party *	string	Nome da principal parte relacionada para assinar o evento (porém é um campo livre).	-
batches *	array of objects	Lista de diferentes tipos de documentos.	-
total_value *	float	Valor total dos documentos do evento.	-
send_emails *	boolean	Indica se os e-mails de assinatura devem ser enviados para este evento de assinatura.	-
send_to_fund_administrator *	boolean	Indica se o evento deve ser enviado para o FROMTIS caso o administrador do fundo o utilize.	-
requester_identifier *	string	Identificador do evento fornecido pelo parceiro.

BATCHES OBJECT

Campo	Tipo	Descrição	Máx. Caract.
related_parties *	array of objects	Partes relacionadas que assinam este batch.	-
documents *	array of objects	lista de documentos enviados no POST /document.	-
name *	string	NNome do arquivo.	-
signature_type *	string	Tipo de assinatura.	-
document_type *	string	Tipo de documento.	-

RELATED PARTIES OBJECT

Campo	Tipo	Descrição	Máx. Caract.
role *	string	Cargo.	-
name *	string	Nome da Empresa.	-
document_number *	string	numero de documento do assinante.	-

Request

ENDPOINT

/batch_group/BATCH_GROUP_KEY/send_to_signature

METHOD

POST

PATH PARAMS

Campo	Descrição
batch_group_key *	Chave única de identificação do evento de assinatura.

O método POST /batch_group/BATCH_GROUP_KEY/send_to_signature" finaliza o grupo de documentos e envia o lote para assinatura.