Contract signing with OPT-IN

Request

ENDPOINT

/debt/DEBT-KEY/signed

METHOD

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

Field	Type	Description	Characters
debt_key *	string	Debt key returned at the moment of credit operation creation.	-

Body Params

Field	Type	Description	Characters
type *	string	Type of signature to be sent.	-
signatures *	array of objects	List containing signature proof objects - must be sent in case of signature "type": "data-signature".	Objects signatures

Object signatures

Field	Type	Description	Characters
signed_object	object	Object containing the document being signed.	Objects signed_object
authenticity	object	Object with authentication data.	Objects authenticity
signer	object	Object with the signatory's data.	Object signer
authentication_type *	string	Type of signature.	-

Object signed_object

Field	Type	Description	Characters
raw_text *	string	Plain text with the contract data to be signed.	-

Object authenticity

Field	Type	Description	Characters
timestamp *	string	Signature date.	-
ip_address	string	Mandatory field for the "opt-in" authentication_type indicating the IP address where the acceptance was collected.	-
session_id	string	Session identification ID of the client at the time of signing - it must be queryable and the session evidence must be stored for a minimum period of 5 years (Mandatory for the "opt-in" authentication_type).	-
geolocation	object	Optional geolocation field.	-

Object signer

Field	Type	Description	Characters
name *	string	Signatory's name.	-
email *	string	Signatory's email.	-
phone	string	Object containing the signatory's phone number	Object phone
document_number *	string	Signatory's document number.	-

Object phone

Field	Type	Description	Characters
country_code *	string	Phone DDI code (https://ddi.guiamais.com.br/)	3
area_code *	string	Phone area code (DDD) (https://ddd.guiamais.com.br/)	2
number *	string	Phone number (numbers only)	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\"}"
}