API
Criar clearance
Cria um novo clearance e retorna seu UUID gerado automaticamente.
POST
/
api
/
clearances
Criar clearance
curl --request POST \
--url https://api.valid.com/api/clearances \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"slug": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.valid.com/api/clearances"
payload = {
"name": "<string>",
"slug": "<string>",
"description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', slug: '<string>', description: '<string>'})
};
fetch('https://api.valid.com/api/clearances', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/api/clearances"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.valid.com/api/clearances")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/clearances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Clearance criado com sucesso.",
"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": "Erro ao criar clearance."
}
Request Body
string
required
Nome do clearance. Exemplo:
SERPRO IDstring
Slug do clearance. Exemplo:
serpro-idstring
Descrição do clearance. Exemplo:
Validação via SERPRO IDResponse
string
Feedback. Exemplo:
Clearance criado com sucesso. (Status 200) - Erro ao criar clearance. (Status 500)object
Dados do clearance criado.
Show properties
Show properties
string
UUID do clearance. Exemplo:
7604086b-cc97-4a2c-b928-7905fa4d6428string
Nome do clearance. Exemplo:
SERPRO IDstring
Slug do clearance. Exemplo:
serpro-idstring
Descrição. Exemplo:
Validação via SERPRO IDstring
Data de criação. Exemplo:
2023-10-10T14:00:00Zstring
Data de atualização. Exemplo:
2023-10-10T14:00:00Z{
"message": "Clearance criado com sucesso.",
"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": "Erro ao criar clearance."
}
⌘I
Criar clearance
curl --request POST \
--url https://api.valid.com/api/clearances \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"slug": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.valid.com/api/clearances"
payload = {
"name": "<string>",
"slug": "<string>",
"description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', slug: '<string>', description: '<string>'})
};
fetch('https://api.valid.com/api/clearances', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/api/clearances"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.valid.com/api/clearances")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/clearances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Clearance criado com sucesso.",
"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": "Erro ao criar clearance."
}