Get list of all resumes

curl --request GET \
  --url https://{region}.affinda.com/v2/resumes \
  --header 'Authorization: Bearer <token>'

{
  "count": 10,
  "results": [
    {
      "identifier": "<string>",
      "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
      "fileName": "Document.pdf",
      "ready": true,
      "readyDt": "2020-12-10T01:43:32.276724Z",
      "failed": false,
      "expiryTime": "2023-11-07T05:31:56Z",
      "language": "en",
      "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
      "parentDocument": {
        "identifier": "<string>"
      },
      "childDocuments": [
        {
          "identifier": "<string>"
        }
      ],
      "pages": [
        {
          "id": 2,
          "pageIndex": 0,
          "image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
          "height": 700,
          "width": 500,
          "rotation": 90,
          "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
        }
      ],
      "isVerified": false,
      "reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
      "ocrConfidence": 0.97,
      "createdDt": "2023-11-07T05:31:56Z",
      "documentType": "resume",
      "regionBias": {
        "country": "<string>",
        "countries": [
          "<string>"
        ],
        "squareCoordinates": [
          123
        ],
        "strict": true
      },
      "isOcrd": true
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

GET

resumes

curl --request GET \
  --url https://{region}.affinda.com/v2/resumes \
  --header 'Authorization: Bearer <token>'

{
  "count": 10,
  "results": [
    {
      "identifier": "<string>",
      "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
      "fileName": "Document.pdf",
      "ready": true,
      "readyDt": "2020-12-10T01:43:32.276724Z",
      "failed": false,
      "expiryTime": "2023-11-07T05:31:56Z",
      "language": "en",
      "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
      "parentDocument": {
        "identifier": "<string>"
      },
      "childDocuments": [
        {
          "identifier": "<string>"
        }
      ],
      "pages": [
        {
          "id": 2,
          "pageIndex": 0,
          "image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
          "height": 700,
          "width": 500,
          "rotation": 90,
          "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
        }
      ],
      "isVerified": false,
      "reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
      "ocrConfidence": 0.97,
      "createdDt": "2023-11-07T05:31:56Z",
      "documentType": "resume",
      "regionBias": {
        "country": "<string>",
        "countries": [
          "<string>"
        ],
        "squareCoordinates": [
          123
        ],
        "strict": true
      },
      "isOcrd": true
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Query Parameters

offset

integer

The number of documents to skip before starting to collect the result set.

Required range: x >= 0

Example:

0

limit

integer

The numbers of results to return.

Required range: 1 <= x <= 100

Example:

20

custom_identifier

string

Filter for documents with this custom identifier.

Response

All resumes for user

count

integer

required

Number of items in results.

Required range: x >= 0

Example:

10

results

object[]

required

Show child attributes

results.identifier

string

Unique identifier for the document

results.customIdentifier

string | null

Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.

Example:

"46ab8b02-0e5b-420c-877c-8b678d46a834"

results.fileName

string | null

Optional filename of the file

Example:

"Document.pdf"

results.ready

boolean

If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling

Example:

true

results.readyDt

string<date-time> | null

The datetime when the document was ready

Example:

"2020-12-10T01:43:32.276724Z"

results.failed

boolean

If true, some exception was raised during processing. Check the 'error' field of the main return object.

Example:

false

results.expiryTime

string<date-time> | null

The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.

results.language

string | null

The document's language.

Example:

"en"

results.pdf

string | null

The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).

Example:

"https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"

results.parentDocument

object

If this document is part of a splitted document, this attribute points to the original document that this document is splitted from.

Show child attributes

results.parentDocument.identifier

string

Unique identifier for the document

results.childDocuments

object[]

If this document has been splitted into a number of child documents, this attribute points to those child documents.

Show child attributes

results.childDocuments.identifier

string

Unique identifier for the document

results.pages

object[]

The document's pages.

Show child attributes

results.pages.id

integer

required

Required range: x >= 1

results.pages.pageIndex

integer

required

Page number within the document, starts from 0.

Required range: x >= 0

Example:

0

results.pages.image

string | null

required

The URL to the image of the page.

Example:

"https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"

results.pages.height

number

required

Height of the page's image in px.

Example:

700

results.pages.width

number

required

Width of the page's image in px.

Example:

500

results.pages.rotation

integer

required

The degree of rotation applied to the page. Greater than 0 indicates clockwise rotation. Less than 0 indicates counter-clockwise rotation.

Required range: -360 <= x <= 360

Example:

90

results.pages.imageTranslated

string | null

The URL to the translated image of the page.

Example:

"https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"

results.isVerified

boolean

This is true if the 'confirm' button has been clicked in the Affinda validation tool

Example:

false

results.reviewUrl

string | null

Signed URL (valid for 60 minutes) to access the validation tool. Not applicable for documents types such a resumes.

Example:

"https://app.affinda.com/review/XJ5kK123?signature=12345"

results.ocrConfidence

number | null

The overall confidence in the conversion of image to text. (only applicable for images or PDF documents without a text layer)

Example:

0.97

results.createdDt

string<date-time>

results.documentType

string

Example:

"resume"

results.regionBias

object

Show child attributes

results.regionBias.country

string | null

A single alpha-2 country code (e.g. AU) used by google geocoding service

results.regionBias.countries

string[] | null

A list of alpha-2 country codes used by Pelias

results.regionBias.squareCoordinates

number[] | null

A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]

results.regionBias.strict

boolean

If true, the location must be within the region, as opposed to prefering locations within the region. Default to false.

Example:

true

results.isOcrd

boolean

string | null

URL to request next page of results.

string | null

URL to request previous page of results.

Update specific mapping Upload a resume for parsing

⌘I

Developer Guide

Developer Tools

Endpoints

Deprecated Versions

Get list of all resumes

Authorizations

Query Parameters

Response