Recuperar Voucher - Certificados ZapSign

GET

/

api

/

v1

/

partners

/

{partnerId}

/

vouchers

/

{voucher_id}

Busca voucher pelo `voucher_id`.

curl --request GET \
  --url https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}', 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://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "voucher_id": "ZS_ECPF_A1_01HXYZABCDEFGHJKMNPQRSTV",
  "certificate_type": "ecpf_a1",
  "status": "issued",
  "issued_at": "2026-05-07T14:32:11.000Z",
  "redeemed_at": null,
  "decline_reason": null,
  "reference_id": "PEDIDO_12345",
  "created_at": "2026-05-07T14:32:11.000Z"
}

Authorizations

Authorization

string

header

required

Token Bearer com prefixo czk_live_. Gere a chave no portal em https://certificados.zapsign.com.br/reseller/api-keys.

Path Parameters

partnerId

string

required

Identificador público do parceiro (Partner ID), exibido no portal.

Required string length: 1 - 64

voucher_id

string

required

Identificador do voucher retornado em POST /vouchers/cpf ou /vouchers/cnpj.

Pattern: ^[A-Z0-9_-]{8,80}$

Example:

"ZS_ECPF_A3_01HXYZABCDEFGHJKMNPQRSTV"

Response

Voucher encontrado.

Shape full retornado por GET /vouchers/{voucher_id} e por cada item de GET /vouchers.

voucher_id

string

required

Identificador único do voucher. Use no link de resgate e nas buscas.

Example:

"ZS_ECPF_A1_01HXYZABCDEFGHJKMNPQRSTV"

certificate_type

enum<string> | null

required

Tipo do certificado. null apenas em vouchers legados.

Available options:

ecpf_a1,

ecpf_a3_nuvem,

ecnpj_a1,

ecnpj_a3_nuvem

Example:

"ecpf_a1"

status

enum<string>

required

Estado atual do voucher no ciclo de vida.

Available options:

issued,

redeemed,

expired,

declined

issued_at

string<date-time> | null

required

Timestamp ISO 8601 de quando o status passou para issued. Costuma ser igual a created_at.

Example:

"2026-05-07T14:32:11.000Z"

redeemed_at

string<date-time> | null

required

Timestamp ISO 8601 de quando o status passou para redeemed.

Example:

null

decline_reason

required

Motivo quando status = declined: um valor de VoucherDeclineReason ou o valor de sistema reseller_self_cancel (cancelamento pelo próprio revendedor). null nos demais estados.

Available options:

missing_cnh_or_prior_certificate,

voucher_expired,

id_mismatch,

documentation_invalid,

facial_validation_failed,

customer_gave_up,

other

reference_id

string | null

required

Alias enviado pelo parceiro na criação. Sempre presente: null quando o voucher foi criado sem alias.

Example:

"PEDIDO_12345"

created_at

string<date-time> | null

required

Timestamp ISO 8601 de criação do voucher.

Example:

"2026-05-07T14:32:11.000Z"

Busca voucher pelo `voucher_id`.

curl --request GET \
  --url https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}', 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://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://certificados.zapsign.com.br/api/v1/partners/{partnerId}/vouchers/{voucher_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "voucher_id": "ZS_ECPF_A1_01HXYZABCDEFGHJKMNPQRSTV",
  "certificate_type": "ecpf_a1",
  "status": "issued",
  "issued_at": "2026-05-07T14:32:11.000Z",
  "redeemed_at": null,
  "decline_reason": null,
  "reference_id": "PEDIDO_12345",
  "created_at": "2026-05-07T14:32:11.000Z"
}