solicitacao_de_consulta

Request

ENDPOINT
/scr
MÉTODO
POST

body.json

{
	"person_type": "natural",
	"name": "João Ninguem",
	"document_number": "42866592832",
    "check_representatives": true,
    "report_start_date": "2019-02",
    "report_end_date": "2020-03",
    "signatures": [{
		"signed_object": {
			"raw_text": "Lorem ipsum dolor sit amet, consectetur a....",
			"document_key": "79003de0-2590-455d-9b73-426b8ca284eb",
			"document_md5": "7521bd5621d97af26b2c1721fc4023a8"
		},
		"authenticity": {
			"timestamp": "1970-01-01 00:00:01",
			"ip_address": "179.104.42.245",
			"session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3",
			"facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb",
			"document_key": "79003de0-2590-455d-9b73-426b8ca284eb",
			"document_md5": "79003de0-2590-455d-9b73-426b8ca284eb"
		},
		"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"
	}]
}

Body Params

字段	类型	描述
`person_type`	enum	被查询人员的类型。
`name`	string	被查询方的姓名。
`document_number`	string	被查询方的 CPF 或 CNPJ。
`check_representatives`	boolean	决定是否查询公司代表人的字段（布尔值"true"或"false"，若省略则视为 false）。
`report_start_date`	string	查询开始日期（格式"YYYY-MM"）。QI Tech 可查询的最早日期为 2019-02。
`report_end_date`	string	查询结束日期（格式"YYYY-MM"）。
`signatures`	array of objects	包含签署方对象的列表。

枚举值

person_type 枚举值

枚举值	翻译
natural	自然人
legal	法人

Response

状态:

200

Response Body: 自然人（PF）

{
	"person_type": "legal",
	"name": "Padaria do Joao Ninguem",
	"document_number": "05305188000108",
    "signers": [
        {
            "name": "Diretor 1",
            "document_number": "41184562067",
            "email": "diretor1@email.com"
        },
        {
            "name": "Diretor 2",
            "document_number": "18631260070",
            "email": "diretor2@email.com"
        }
    ],
	"report_start_date": "2019-02",
	"report_end_date": "2020-03" ,
    "check_representatives": true
}

状态:

200

Response Body: 法人（PJ）

{
   "webhook_type": "scr",
   "key": "f33384e8-13ed-4e43-adf3-1ba20a4a6004",
   "status": "pending_signature",
   "event_datetime": "1970-01-01 00:00:01"
}

状态:

400

body.json

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

Request​

Body Params​

枚举值​

person_type 枚举值​

Response​

Request

Body Params

枚举值

person_type 枚举值

Response