跳到主要内容

通过 OPT-IN 签署合同

请求​

ENDPOINT
/debt/DEBT-KEY/signed
MÉTODO
POST
请求体
{
    "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"
        }
    ]
}

路径参数​

字段类型描述字符数
debt_key *string创建信贷操作时返回的债务密钥。-

请求体参数​

字段类型描述字符数
type *string将要发送的签署类型。-
signatures *array of objects包含签署证明对象的列表——在签署类型为"data-signature"时发送。signatures 对象

signatures 对象​

字段类型描述字符数
signed_objectobject包含正在签署文件的对象。signed_object 对象
authenticityobject包含认证数据的对象。authenticity 对象
signerobject包含签署人数据的对象。signer 对象
authentication_type *string签署类型。-

signed_object 对象​

字段类型描述字符数
raw_text *string包含将要签署的合同数据的连续文本。-

authenticity 对象​

字段类型描述字符数
timestamp *string签署日期。-
ip_addressstring对于"opt-in"认证类型为必填字段，表示收集接受时的 IP 地址。-
session_idstring签署时客户的会话标识 ID——必须可查询，会话证据须保存至少 5 年（"opt-in"认证类型必填）。-
geolocationobject可选地理位置字段。-

signer 对象​

字段类型描述字符数
name *string签署人姓名。-
email *string签署人电子邮件。-
phonestring签署人电话对象。phone 对象
document_number *string签署人证件号码。-

phone 对象​

字段类型描述字符数
country_code *string电话国家代码（https://ddi.guiamais.com.br/）3
area_code *string电话区号（https://ddd.guiamais.com.br/）2
number *string电话号码（仅数字）10

响应​

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

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