Create Disability Analysis

Public Create Analysis

curl --request POST \
  --url https://public-api.salu.com.vc/dev/routes/v0/analysis/disability \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "gov_id": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://public-api.salu.com.vc/dev/routes/v0/analysis/disability"

payload = {
    "name": "<string>",
    "gov_id": "<string>",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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>',
    gov_id: '<string>',
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    employee_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://public-api.salu.com.vc/dev/routes/v0/analysis/disability', 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://public-api.salu.com.vc/dev/routes/v0/analysis/disability",
  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>',
    'gov_id' => '<string>',
    'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'employee_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://public-api.salu.com.vc/dev/routes/v0/analysis/disability"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"gov_id\": \"<string>\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"employee_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://public-api.salu.com.vc/dev/routes/v0/analysis/disability")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"gov_id\": \"<string>\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"employee_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.salu.com.vc/dev/routes/v0/analysis/disability")

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  \"gov_id\": \"<string>\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"employee_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "gov_id": "<string>",
  "status": "IN_ANALYSIS",
  "request_date": "2023-11-07T05:31:56Z",
  "organization": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "validation_date": "2023-11-07T05:31:56Z",
  "observation": "<string>",
  "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "disabilities": [
    {}
  ],
  "expiration_date": "2023-11-07T05:31:56Z",
  "expired": true,
  "analysis_files": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

analysis

disability

Public Create Analysis

curl --request POST \
  --url https://public-api.salu.com.vc/dev/routes/v0/analysis/disability \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "gov_id": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://public-api.salu.com.vc/dev/routes/v0/analysis/disability"

payload = {
    "name": "<string>",
    "gov_id": "<string>",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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>',
    gov_id: '<string>',
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    employee_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://public-api.salu.com.vc/dev/routes/v0/analysis/disability', 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://public-api.salu.com.vc/dev/routes/v0/analysis/disability",
  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>',
    'gov_id' => '<string>',
    'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'employee_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://public-api.salu.com.vc/dev/routes/v0/analysis/disability"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"gov_id\": \"<string>\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"employee_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://public-api.salu.com.vc/dev/routes/v0/analysis/disability")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"gov_id\": \"<string>\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"employee_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.salu.com.vc/dev/routes/v0/analysis/disability")

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  \"gov_id\": \"<string>\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"employee_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "gov_id": "<string>",
  "status": "IN_ANALYSIS",
  "request_date": "2023-11-07T05:31:56Z",
  "organization": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "validation_date": "2023-11-07T05:31:56Z",
  "observation": "<string>",
  "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "disabilities": [
    {}
  ],
  "expiration_date": "2023-11-07T05:31:56Z",
  "expired": true,
  "analysis_files": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Creates a disability (PCD) analysis for a candidate or employee. See the concept in PCD analysis and the full flow.

Overview

Method: POST
Path: /v0/analysis/disability
OperationId: public_create_analysis_v0_analysis_disability_post
Authentication: x-api-key header

Main fields

Field	Required	Meaning
`name`	yes	Candidate/employee name.
`gov_id`	yes	CPF (11 digits). Accepted with or without punctuation/mask — the value is automatically normalized before validation.
`organization_id`	yes	Organization of the analysis. Must be within the API key’s scope.
`employee_id`	optional	Set it when the candidate is already an employee of the organization. When provided, it must reference an existing employee that belongs to the same `organization_id` — check with `GET /v0/employee/{employee_id}` beforehand.

Status enum (response)

Value	Meaning
`IN_ANALYSIS`	Under review
`INCOMPLETE`	Incomplete (missing data or documents)
`APPROVED`	Approved
`REPROVED`	Rejected
`EXPIRED`	Expired

On creation (201), the analysis always starts with status: "IN_ANALYSIS" and empty result fields: disabilities, expiration_date, validation_date and observation come back null, and analysis_files comes back []. Those fields are only populated after review — track them with GET /v0/analysis/{analysis_id}.

request_date is returned in ISO 8601 format without a timezone offset (e.g. 2026-07-26T23:53:09.157023). Do not assume your own server’s timezone when parsing it.

Error codes

Besides 422 (invalid fields, shown in the playground above):

Code	Situation
`403`	`organization_id` is out of the API key’s scope, or the `x-api-key` header is missing/invalid.
`409`	An active PCD analysis (`IN_ANALYSIS` or `INCOMPLETE`) already exists for the same `gov_id` within the same `organization_id`.

Next step

Once created, attach the report/document via POST /v0/analysis/files.

Request example

curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/analysis/disability" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SALU_PUBLIC_API_KEY" \
  --data '{
    "name": "MARIA DA SILVA",
    "gov_id": "12345678901",
    "organization_id": "ORGANIZATION_UUID",
    "employee_id": null
  }'

Authorizations

x-api-key

string

header

required

Body

application/json

name

string

required

gov_id

string

required

organization_id

string<uuid>

required

employee_id

string<uuid> | null

Obrigatório quando o candidato já é colaborador da organização.

Response

Successful Response

string<uuid>

required

name

string

required

gov_id

string

required

status

enum<string>

required

Available options:

IN_ANALYSIS,

INCOMPLETE,

APPROVED,

REPROVED,

EXPIRED

request_date

string<date-time>

required

organization

SimpleOrganization · object

required

Show child attributes

validation_date

string<date-time> | null

observation

string | null

employee_id

string<uuid> | null

disabilities

Disabilities · object[] | null

expiration_date

string<date-time> | null

expired

boolean | null

analysis_files

PublicApiAnalysisFileResponse · object[]

Show child attributes

Início

PT-BR

EN

Overview

Main fields

Status enum (response)

Error codes

Next step

Request example

Authorizations

Body

Response

​Overview

​Main fields

​Status enum (response)

​Error codes

​Next step

​Request example

Authorizations

Body

Response

Overview

Main fields

Status enum (response)

Error codes

Next step

Request example