GET
/
v2
/
resumes
Get list of all resumes
curl --request GET \
  --url https://{region}.affinda.com/v2/resumes \
  --header 'Authorization: Bearer <token>'
{
  "count": 10,
  "next": "<string>",
  "previous": "<string>",
  "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",
          "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
          "height": 700,
          "width": 500,
          "rotation": 90
        }
      ],
      "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
    }
  ]
}

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

200
application/json

All resumes for user

The response is of type object.