Applicant documents

List of valid attributes:

Attribute	Description	Specifics
applicant_id	ID of the applicant for the document	Cannot be set
extension	File extension	Required. One of: pdf, doc, docx, jpg, jpeg, png
name	Display name for the document	Required. Maximum length is 250 characters

The server sets upload_status to uploading on create. Updating status after S3 upload (success or error) is done via a separate update endpoint.

Meta: Download/Upload URL

Parameter	Allowed values	Description
download_url	true/false	When passing true, it returns the download URL for the document
upload_url	true/false	When passing true, it generates a temporary URL to use for uploading a document

Note: upload_url returns a presigned POST S3 object, which contains url and fields keys, which can be used for HTML form. Maximum file size for applicant document upload is 10MB. Maximum of 10 documents per applicant is allowed.

Create document (public endpoint)

Example request:

{
  "data": {
    "type": "applicant_document",
    "attributes": {
      "extension": "pdf",
      "name": "Resume"
    }
  }
}

Example response:

{
  "data": {
    "id": "52370ab1-7d08-4a03-b0ac-4ba63c8f209d",
    "type": "applicant_document",
    "attributes": {
      "applicant_id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93",
      "extension": "pdf",
      "name": "Resume"
    },
    "meta": {
      "upload_url": {
        "url": "https://example-bucket.s3.amazonaws.com/",
        "fields": {...}
      }
    }
  }
}

Creates an applicant_document in uploading status.

HTTP Request

POST /public/v1/applicants/:applicant_id/documents

URL parameters

Parameter	Description
applicant_id	ID of the applicant (must exist and not be discarded)

Notes

• The applicant must be active.
• Allowed extensions are limited to the list above.
• At most 10 documents per applicant.

Update document (public endpoint)

Example request:

{
  "data": {
    "type": "applicant_document",
    "attributes": {
      "name": "Updated Resume",
      "upload_status": "success"
    }
  }
}

Example response:

{
  "data": {
    "id": "52370ab1-7d08-4a03-b0ac-4ba63c8f209d",
    "type": "applicant_document",
    "attributes": {
      ...
    }
  }
}

Updates an applicant_document with the given ID and returns it.

HTTP Request

PUT /public/v1/applicants/:applicant_id/documents/:id

URL parameters

Parameter	Description
applicant_id	ID of the applicant (must exist and not be discarded)
id	ID of the document to update

Show

Example response:

{
  "data": {
    "id": "52370ab1-7d08-4a03-b0ac-4ba63c8f209d",
    "type": "applicant_document",
    "attributes": {
      ...
    }
  }
}

This endpoint returns an applicant document.

HTTP Request

GET /api/v1/applicants/:applicant_id/documents/:id

URL Parameters

Parameter	Description
applicant_id	ID of the applicant (must exist and not be discarded)
id	ID of the document to fetch