Consulta a situacao de uma solicitacao de assinatura.
curl --request GET \
--url https://api.example.com/api/services/app/Assinaturas/Consultarimport requests
url = "https://api.example.com/api/services/app/Assinaturas/Consultar"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/services/app/Assinaturas/Consultar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Assinaturas/Consultar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Assinaturas/Consultar"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/services/app/Assinaturas/Consultar")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Assinaturas/Consultar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"code": "<string>",
"provider": 123,
"documentName": "<string>",
"partnerReference": "<string>",
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"signers": [
{
"name": "<string>",
"registryCode": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-11-07T05:31:56Z",
"signUrl": "<string>",
"status": 123,
"signedAt": "2023-11-07T05:31:56Z",
"biometry": {
"provider": "<string>",
"result": "<string>",
"reason": "<string>",
"band": "<string>",
"score": 123,
"checkedAt": "2023-11-07T05:31:56Z"
}
}
]
}Assinaturas
Consultar
GET
/
api
/
services
/
app
/
Assinaturas
/
Consultar
Consulta a situacao de uma solicitacao de assinatura.
curl --request GET \
--url https://api.example.com/api/services/app/Assinaturas/Consultarimport requests
url = "https://api.example.com/api/services/app/Assinaturas/Consultar"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/services/app/Assinaturas/Consultar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Assinaturas/Consultar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Assinaturas/Consultar"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/services/app/Assinaturas/Consultar")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Assinaturas/Consultar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"code": "<string>",
"provider": 123,
"documentName": "<string>",
"partnerReference": "<string>",
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"signers": [
{
"name": "<string>",
"registryCode": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-11-07T05:31:56Z",
"signUrl": "<string>",
"status": 123,
"signedAt": "2023-11-07T05:31:56Z",
"biometry": {
"provider": "<string>",
"result": "<string>",
"reason": "<string>",
"band": "<string>",
"score": 123,
"checkedAt": "2023-11-07T05:31:56Z"
}
}
]
}Devolve a situação atual da solicitação e de cada signatário. Use enquanto a assinatura estiver aberta: o webhook pode falhar, e a consulta é o que evita ficar sem informação.
Autentique-se antes (Autenticação). O
code é o que o Enviar devolveu. Os valores de status estão na Introdução.curl -X GET "https://gateway.hubcred.com.br/external/v1/api/services/app/Assinaturas/Consultar?code=3f2b1c40-9a77-4c1e-9b3d-2f8a1d5e7c04" -H "Authorization: Bearer SEU_TOKEN"
Query Parameters
Code publico da solicitacao de assinatura.
Response
OK
Uma solicitacao de assinatura.
Code publico da solicitacao
Provedor: 1 Unico ID, 2 ZapSign
Nome do documento
Chave de idempotencia do parceiro
Situacao: 0 Pendente, 1 Enviado, 2 Assinado, 3 Recusado, 4 Cancelado, 5 Expirado, 6 Falhou
Momento da criacao
Momento da conclusao
Signatarios da solicitacao
Show child attributes
Show child attributes