Skip to main content
POST
Public Create Analysis
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

Status enum (response)

Request example

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

id
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
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[]