Assinatura de contrato com OPT-IN

Request

ENDPOINT

/debt/DEBT-KEY/signed

MÉTODO

POST

Request Body

{
    "type": "data_signature",
    "signatures": [
        {
            "signed_object": {
                "raw_text": "Lorem ipsum dolor sit amet, consectetur a...."
            },
            "authenticity": {
                "timestamp": "1970-01-01 00:00:01",
                "ip_address": "179.104.42.245",
                "session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3"
            },
            "signer": {
                "name": "IVANILDO DE SENA LIMA",
                "email": "ivanlima2604@gmail.com",
                "phone": {
                    "country_code": "055",
                    "area_code": "11",
                    "number": "999999999"
                },
                "document_number": "61766976204"
            },
            "authentication_type": "opt-in"
        }
    ]
}

Path Params

Campo	Tipo	Descrição	Caracteres
debt_key *	string	Chave da divida devolvida no momento da criação da operação de crédito.	-

Body Params

Campo	Tipo	Descrição	Caracteres
type *	string	Tipo de assinatura que será enviada.	-
signatures *	array of objects	Lista contendo objetos de comprovação de assinatura - deve ser enviado no caso de assinatura "type": "data-signature".	Objetos signatures

Objeto signatures

Campo	Tipo	Descrição	Caracteres
signed_object	object	Objeto contendo o documento que esta sendo assinado.	Objetos signed_object
authenticity	object	objeto com dados de autenticação.	Objetos authenticity
signer	object	Objeto com os dados do signatário.	Objeto signer
authentication_type *	string	Tipo de assinatura.	-

Objeto signed_object

Campo	Tipo	Descrição	Caracteres
raw_text *	string	Texto corrido com os dados do contrato que será assinado.	-

Objeto authenticity

Campo	Tipo	Descrição	Caracteres
timestamp *	string	Data da assinatura.	-
ip_address	string	Campo obrigatório para o authentication_type “opt-in” indicando o endereço de IP onde o aceite foi coletado.	-
session_id	string	ID de identificação de sessão do cliente no momento da assinatura - deve ser consultável e as evidencias da sessão devem ser armazenadas por um período de no mínimo 5 anos (Obrigatório para o authentication_type "opt-in").	-
geolocation	object	Campo opcional de geolocalização.	-

Objeto signer

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do signatário.	-
email *	string	E-mail do signatário.	-
phone	string	Objeto de telefone do signatário.	Objeto phone
document_number *	string	Numero de documento do signatário.	-

Objeto phone

Campo	Tipo	Descrição	Caracteres
country_code *	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
area_code *	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	2
number *	string	Número de telefone (apenas números)	10

Response

STATUS

200

Response Body

{
  "data": {},
  "event_datetime": "2022-11-07 15:24:47",
  "key": "\<DEBT-KEY\>",
  "status": "signature_received",
  "webhook_type": "debt"
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}