Skip to main content
POST
/
api
/
clearances
Criar clearance
curl --request POST \
  --url https://api-hml.valid.com/api/clearances \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>"
}
'
{
  "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"
  }
}

​
Request Body

​
name
string
required
Nome do clearance. Exemplo: SERPRO ID
​
slug
string
Slug do clearance. Exemplo: serpro-id
​
description
string
Descrição do clearance. Exemplo: Validação via SERPRO ID

​
Response

​
message
string
Feedback. Exemplo: Clearance criado com sucesso. (Status 200) - Erro ao criar clearance. (Status 500)
​
clearance
object
Dados do clearance criado.
{
  "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"
  }
}