Skip to main content
GET
Retrieve an income and employment report

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

report_id
string
required
user_id
string
required

Query Parameters

report_type
enum<string>
default:payroll

Report type

Available options:
payroll,
aim_check
fmt
enum<string>
default:json

Response format

Available options:
json,
pdf

Response

report_id
string
required
read-only

Unique identifier of the report.

Maximum string length: 32
Example:

"48427a36d43c4d5aa6324bc06c692456"

created_at
string<date-time>
required
read-only

Timestamp when the report was created.

Example:

"2022-05-04T11:30:00Z"

completed_at
string<date-time>
required
read-only

Timestamp when the report was completed.

Example:

"2022-05-04T12:00:00Z"

last_task_at
string<date-time>
required
read-only

Created timestamp of the latest task.

Example:

"2022-05-04T12:00:00Z"

List of employment links