Skip to main content
GET
Public Get Analysis
Returns an analysis by its identifier. Use it to track the status of a PCD analysis.

Overview

  • Method: GET
  • Path: /v0/analysis/{analysis_id}
  • OperationId: public_get_analysis_v0_analysis__analysis_id__get
  • Authentication: x-api-key header

Parameters

In analysis_files, the file_path field is a temporary (presigned) download URL for the file, valid for roughly 1 hour after the request. Do not store it: once it expires, simply call the endpoint again to get a fresh URL.

Error codes

Request example

Authorizations

x-api-key
string
header
required

Path Parameters

analysis_id
string<uuid>
required

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