Reports

Generate PDF and JSON summaries based on Argyle's data sets.

Example reports:

Before generating a report:

  • To ensure full data availability, we recommend subscribing to the reports.ready webhook, which is sent when sufficient data has been retrieved to generate a verification report.
  • Depending on the data retrieval speed limits of the underlying payroll platform, it can take from a few seconds up to several minutes after a new account connection before enough data has been synced to generate a complete report.
    • Visit the data availability section of our API Guide for more information on the timing of data retrieval.

After generating a report:

  • A new report object is created. The file_url and json_url properties contain links to the report PDF and report JSON.
  • The report PDF and report JSON will also appear and can be downloaded within Console.

#The report object

Attributes
  • #
    idstring (uuid)

    Unique ID of the report object.

    Also the "Reference #" on the report PDF.

  • #
    userstring (uuid)
    ID of the user associated with the report.
  • #
    (Deprecated) reference_idstring (uuid)

    Report PDF identifier.

  • #
    (Deprecated) generated_atstring (datetime)

    Timestamp (ISO 8601) when the report was requested.

  • #
    created_atstring (datetime)

    Timestamp (ISO 8601) when the report was requested.

  • #
    typestring (enum)

    The type of report.

  • #
    statusstring (enum)

    Progress of report generation.

  • #
    file_urlstring

    Download link to the report PDF.
    — Requires Argyle authentication headers.

  • #
    json_urlstring

    Download link to the report in JSON.
    — Requires Argyle authentication headers.

  • #
    accountsarray of objects
    The accounts used to generate the report.
  • #
    idstring (uuid)
    ID of the account.
  • #
    itemstring
    ID of the Item in Link through which the account was connected.
  • #
    last_synced_atstring (datetime)

    Timestamp (ISO 8601) when the account was last scanned for new data before the report was generated.

  • #
    metadataobject
    Any metadata for internal use added when generating the report.
  • #
    last_synced_atstring (datetime)

    Timestamp (ISO 8601) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.

    Used to populate the "Data as of" date on the report PDF.

  • #
    external_idstring

    The external_id of the user, otherwise null.

Example
1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
5  "generated_at": "2023-03-09T16:22:06.081Z",
6  "created_at": "2023-03-09T16:22:06.081Z",
7  "type": "voie",
8  "status": "generated",
9  "file_url": "www.argyle.com/storagename/pdf",
10  "json_url": "www.argyle.com/storagename/json",
11  "accounts": [
12    {
13      "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
14      "item": "item_123456789",
15      "last_synced_at": "2023-03-09T14:08:25.069105Z"
16    },
17    {
18      "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
19      "item": "item_000000001",
20      "last_synced_at": "2023-03-01T05:10:59.558295Z"
21    }
22  ],
23  "metadata": {},
24  "last_synced_at": "2023-03-09T14:08:25.069Z",
25  "external_id": "July_Connection"
26}

#Generate a report

post/v2/reports/{type}

Generates a new report and returns a report object.

There is a daily limit of 10 reports per user to prevent excessive report generation due to accidental client-side errors.


If the daily report limit is reached, deleting a previously generated report from the same 24 hour period will allow another report to be generated.

Path parameters
  • #
    typestring (enum)
    required

    The type of report to generate.

Request body
  • #
    userstring (uuid)
    required
    ID of the user.
  • #
    metadataobject
    optional
    Information for internal use, structured as a JSON object.
Example Request
1curl --request POST \
2     --url https://api.argyle.com/v2/reports/voie \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69"
7     }'
Example Response
1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
5  "generated_at": "2023-03-09T16:22:06.081Z",
6  "created_at": "2023-03-09T16:22:06.081Z",
7  "type": "voie",
8  "status": "generating",
9  "file_url": "www.argyle.com/storagename/pdf",
10  "json_url": "www.argyle.com/storagename/json",
11  "accounts": [
12    {
13      "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
14      "item": "item_123456789",
15      "last_synced_at": "2023-03-09T14:08:25.069105Z"
16    },
17    {
18      "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
19      "item": "item_000000001",
20      "last_synced_at": "2023-03-01T05:10:59.558295Z"
21    }
22  ],
23  "metadata": {},
24  "last_synced_at": "2023-03-09T14:08:25.069Z",
25  "external_id": "July_Connection"
26}

#Retrieve a report

get/v2/reports/{id}

Retrieves a report object.

Path parameters
  • #
    idstring (uuid)
    required
    ID of the report object to be retrieved.
Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/reports/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
5  "generated_at": "2023-03-09T16:22:06.081Z",
6  "created_at": "2023-03-09T16:22:06.081Z",
7  "type": "voie",
8  "status": "generated",
9  "file_url": "www.argyle.com/storagename/pdf",
10  "json_url": "www.argyle.com/storagename/json",
11  "accounts": [
12    {
13      "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
14      "item": "item_123456789",
15      "last_synced_at": "2023-03-09T14:08:25.069105Z"
16    },
17    {
18      "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
19      "item": "item_000000001",
20      "last_synced_at": "2023-03-01T05:10:59.558295Z"
21    }
22  ],
23  "metadata": {},
24  "last_synced_at": "2023-03-09T14:08:25.069Z",
25  "external_id": "July_Connection"
26}

#Delete a report

delete/v2/reports/{id}

Deletes a report object.

Path parameters
  • #
    idstring (uuid)
    required
    ID of the report object to be deleted.
Example Request
1curl --request DELETE \
2     --url https://api.argyle.com/v2/reports/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1"204 status code: No content."

#List all reports

get/v2/reports

Returns an array of all report objects.

Query parameters
  • #
    userstring (uuid)
    optional

    Filter by user ID.

  • #
    limitinteger
    optional

    Number of report objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/reports?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "5b3fa756-1d76-43e1-55f6-e29fc6ae535d",
4    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5    "reference_id": "5b3fa756-1d76-43e1-55f6-e29fc6ae535d",
6    "generated_at": "2023-03-01T22:45:08.916Z",
7    "created_at": "2023-03-01T22:45:08.916Z",
8    "type": "voe",
9    "status": "generated",
10    "file_url": "www.argyle.com/storagename/pdf",
11    "json_url": "www.argyle.com/storagename/json",
12    "accounts": [
13      {
14        "id": "018e6a25-130b-3b98-a3ca-1658cb3afc26",
15        "item": "item_987654321",
16        "last_synced_at": "2023-03-01T19:20:21.576363Z"
17      }
18    ],
19    "metadata": {},
20    "last_synced_at": "2023-03-01T19:20:21.576Z",
21    "external_id": null
22  },
23  {
24    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
25    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
26    "reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
27    "generated_at": "2023-03-09T16:22:06.081Z",
28    "created_at": "2023-03-09T16:22:06.081Z",
29    "type": "voie",
30    "status": "generated",
31    "file_url": "www.argyle.com/storagename/pdf",
32    "json_url": "www.argyle.com/storagename/json",
33    "accounts": [
34      {
35        "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
36        "item": "item_123456789",
37        "last_synced_at": "2023-03-09T14:08:25.069105Z"
38      },
39      {
40        "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
41        "item": "item_000000001",
42        "last_synced_at": "2023-03-01T05:10:59.558295Z"
43      }
44    ],
45    "metadata": {},
46    "last_synced_at": "2023-03-09T14:08:25.069Z",
47    "external_id": "July_Connection"
48  }
49]

Legacy reports documentation

Updating Argyle status...
© 2025 Argyle Systems Inc.argyle.com