IRironcladapp
Records

Get Attachment Download URLs Status

Changed on

Poll the status of a previously submitted attachment download URLs job.

OAuth Scope required: public.records.readAttachments

get/records/attachments/download-urls/{jobId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/records/attachments/download-urls/{jobId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.records.readAttachments

Path parameters

jobIdstring required

The job ID returned from the create attachment download URLs endpoint.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

The current status of the job.

jobIdstring required

The opaque job identifier.

status'processing' | 'complete' | 'failed' required

The current status of the job.

Example response

{
  "succeeded": [
    {
      "identifier": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
      "ironcladId": "IC-123",
      "recordId": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
      "downloadUrl": "https://storage.googleapis.com/ic_record_attachments/645aae3352150fe4e59ef90/6f5c8167-81a6-459c-a53c-eec9fa7e91c9/8674ec0992b199f7902d2459fc0f60b34616db93d28568f7003f6f1d1?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sa-ic-dev%40na1-flex-c34f.iam.gserviceaccount.com%2F20260306%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20260306T230715Z&X-Goog-Expires=1200&X-Goog-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22nda-with-table.pdf%22&X-Goog-Signature=40c961dd454de9bb1e80e4994643eee746ed0eb23da3482bd54d6570a267203063ed7e9a8c6e3797386144ce76c9d3272d37040e69940a3877afb4f082e179335a6d4995a4afb70aa20c1ec65af9e27b819e16d34e2f6d9b8e7233c9eb8ef7736c5d4e9507ea58ec48407ad7f2e0c46bb8053b989af67c187cea7258f48e26757b11045891ad7a5f114a65f7dec85405f981101ed77a4a3356e92edd113db391b6bc111357f02e5d05e39437b0d3b057cf9666f8318b04bcc31d30706ab7117f282eb64ab27669b522052d3ac24ede1cca1a1ad5e7c604e38f74eb20b3022007fa9186ed1b773177c88ccb54524addeb08a7624db2720041082997",
      "filename": "contract.pdf",
      "fileKey": "signedCopy[1]",
      "fileId": "d2079940-3049-4883-8931-2210a3864504",
      "fileHash": "8674ec0992b199f79c5802d2459fc0f60b3461601fcdb93d28568f7003f6f1d1",
      "expiration": "2026-03-07T00:00:00.000Z"
    }
  ],
  "failed": [
    {
      "identifier": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
      "ironcladId": "IC-123",
      "recordId": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
      "errorMessage": "Access denied"
    }
  ]
}

Changes