API
Obter clearance
Retorna os detalhes de um clearance com base em seu UUID.
GET
/
api
/
clearances
/
{uuid}
Obter clearance
curl --request GET \
--url https://api.valid.com/api/clearances/{uuid} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/api/clearances/{uuid}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.valid.com/api/clearances/{uuid}', 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.valid.com/api/clearances/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.valid.com/api/clearances/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.valid.com/api/clearances/{uuid}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/clearances/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"clearance": {
"uuid": "7604086b-cc97-4a2c-b928-7905fa4d6428",
"name": "SERPRO ID",
"slug": "serpro-id",
"description": "Validação via SERPRO ID",
"created_at": "2023-10-10T14:00:00Z",
"updated_at": "2023-10-10T14:00:00Z"
}
}
{
"message": "Clearance não encontrado."
}
{
"message": "Erro ao buscar clearance."
}
Path Parameters
string
required
UUID do clearance. Exemplo:
7604086b-cc97-4a2c-b928-7905fa4d6428Response
object
{
"clearance": {
"uuid": "7604086b-cc97-4a2c-b928-7905fa4d6428",
"name": "SERPRO ID",
"slug": "serpro-id",
"description": "Validação via SERPRO ID",
"created_at": "2023-10-10T14:00:00Z",
"updated_at": "2023-10-10T14:00:00Z"
}
}
{
"message": "Clearance não encontrado."
}
{
"message": "Erro ao buscar clearance."
}
⌘I
Obter clearance
curl --request GET \
--url https://api.valid.com/api/clearances/{uuid} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/api/clearances/{uuid}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.valid.com/api/clearances/{uuid}', 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.valid.com/api/clearances/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.valid.com/api/clearances/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.valid.com/api/clearances/{uuid}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/clearances/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"clearance": {
"uuid": "7604086b-cc97-4a2c-b928-7905fa4d6428",
"name": "SERPRO ID",
"slug": "serpro-id",
"description": "Validação via SERPRO ID",
"created_at": "2023-10-10T14:00:00Z",
"updated_at": "2023-10-10T14:00:00Z"
}
}
{
"message": "Clearance não encontrado."
}
{
"message": "Erro ao buscar clearance."
}