Skip to main content
PATCH
/
v2
/
job_descriptions
/
{identifier}
Update a job description's data
curl --request PATCH \
  --url https://{region}.affinda.com/v2/job_descriptions/{identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobTitle": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>"
  },
  "contactEmail": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "contactName": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "contactPhone": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "startDate": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "2022-02-09"
  },
  "endDate": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "2022-02-09"
  },
  "jobType": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "languages": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "pageIndex": 0,
      "raw": "2/9/2022",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "dataPoint": "<string>",
      "contentType": "<string>"
    }
  ],
  "skills": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "pageIndex": 0,
      "raw": "2/9/2022",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "dataPoint": "<string>",
      "contentType": "<string>"
    }
  ],
  "organizationName": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "organizationWebsite": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "educationLevel": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "educationAccreditation": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "expectedRemuneration": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": {
      "minimum": "3455343.50",
      "maximum": "55545343.50",
      "currency": "USD",
      "unit": "Annually"
    }
  },
  "location": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>"
  },
  "certifications": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "pageIndex": 0,
      "raw": "2/9/2022",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "dataPoint": "<string>",
      "contentType": "<string>",
      "parsed": "John Smith"
    }
  ],
  "yearsExperience": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": {
      "minimum": 0.5,
      "maximum": 5
    }
  }
}
'
import requests

url = "https://{region}.affinda.com/v2/job_descriptions/{identifier}"

payload = {
"jobTitle": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>"
},
"contactEmail": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"contactName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"contactPhone": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"startDate": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "2022-02-09"
},
"endDate": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "2022-02-09"
},
"jobType": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"languages": [
{
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>"
}
],
"skills": [
{
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>"
}
],
"organizationName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"organizationWebsite": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"educationLevel": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"educationAccreditation": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
},
"expectedRemuneration": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": {
"minimum": "3455343.50",
"maximum": "55545343.50",
"currency": "USD",
"unit": "Annually"
}
},
"location": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>"
},
"certifications": [
{
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": "John Smith"
}
],
"yearsExperience": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"pageIndex": 0,
"raw": "2/9/2022",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": True,
"isClientVerified": True,
"isAutoVerified": True,
"dataPoint": "<string>",
"contentType": "<string>",
"parsed": {
"minimum": 0.5,
"maximum": 5
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jobTitle: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>'
},
contactEmail: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
contactName: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
contactPhone: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
startDate: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: '2022-02-09'
},
endDate: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: '2022-02-09'
},
jobType: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
languages: [
{
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>'
}
],
skills: [
{
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>'
}
],
organizationName: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
organizationWebsite: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
educationLevel: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
educationAccreditation: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
},
expectedRemuneration: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: {
minimum: '3455343.50',
maximum: '55545343.50',
currency: 'USD',
unit: 'Annually'
}
},
location: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>'
},
certifications: [
{
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: 'John Smith'
}
],
yearsExperience: {
id: 2,
rectangle: {x0: 2.43, y0: 4.55, x1: 4.56, y1: 6.32, pageIndex: 1},
pageIndex: 0,
raw: '2/9/2022',
confidence: 0.86,
classificationConfidence: 0.95,
textExtractionConfidence: 0.9,
isVerified: true,
isClientVerified: true,
isAutoVerified: true,
dataPoint: '<string>',
contentType: '<string>',
parsed: {minimum: 0.5, maximum: 5}
}
})
};

fetch('https://{region}.affinda.com/v2/job_descriptions/{identifier}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "jobTitle": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": {
      "name": "Software Developer",
      "emsiId": "ETE2AD3A1C11B4EC9B",
      "managementLevel": "Mid",
      "classification": {
        "socCode": 2463,
        "title": "Clergy",
        "minorGroup": "Welfare Professionals",
        "subMajorGroup": "BUSINESS, MEDIA AND PUBLIC SERVICE PROFESSIONALS",
        "majorGroup": "PROFESSIONAL OCCUPATIONS",
        "minorGroupCode": 4122,
        "subMajorGroupCode": 4122,
        "majorGroupCode": 4122
      }
    }
  },
  "contactEmail": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "contactName": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "contactPhone": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "startDate": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "2022-02-09"
  },
  "endDate": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "2022-02-09"
  },
  "jobType": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "languages": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "Mandarin Chinese"
    }
  ],
  "skills": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "Mandarin Chinese"
    }
  ],
  "organizationName": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "organizationWebsite": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "educationLevel": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "educationAccreditation": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": "<string>"
  },
  "expectedRemuneration": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": {
      "minimum": "3455343.50",
      "maximum": "55545343.50",
      "currency": "USD",
      "unit": "Annually"
    }
  },
  "location": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": {
      "rawInput": "Blacksburg, VA",
      "formatted": "Blacksburg, VA, USA",
      "postalCode": "3124",
      "state": "Virginia",
      "stateCode": "TX",
      "country": "United States",
      "countryCode": "US",
      "streetNumber": "1",
      "street": "Smith St",
      "apartmentNumber": "12",
      "city": "Blacksburg",
      "latitude": "67.0124",
      "longitude": "67.0124",
      "poBox": "P.O. Box 123"
    }
  },
  "certifications": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    }
  ],
  "yearsExperience": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "rectangles": [
      {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      }
    ],
    "pageIndex": 0,
    "raw": "<string>",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "contentType": "<string>",
    "dataPoint": "<string>",
    "parsed": {
      "minimum": 0.5,
      "maximum": 5
    }
  },
  "rawText": "Human Resources Assistant Switzerland '... <rest of job description text>'"
}
{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}
{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}
{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}

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.

Path Parameters

identifier
string
required

Job description identifier A random string that uniquely identify the resource.

Body

application/json

Job description data to update

A JSON-encoded string of the JobDescriptionData object.

jobTitle
object | null
contactEmail
object | null
contactName
object | null
contactPhone
object | null
startDate
object | null
endDate
object | null
jobType
object | null
languages
(object | null)[]
skills
(object | null)[]
organizationName
object | null
organizationWebsite
object | null
educationLevel
object | null
educationAccreditation
object | null
expectedRemuneration
object | null
location
object | null
certifications
(object | null)[]
yearsExperience
object | null
{key}

For custom fields. E.g. 'isAvailable': true

Response

object | null

Successfully updated job description data

jobTitle
object | null
contactEmail
object | null
contactName
object | null
contactPhone
object | null
startDate
object | null
endDate
object | null
jobType
object | null
languages
(object | null)[]
skills
(object | null)[]
organizationName
object | null
organizationWebsite
object | null
educationLevel
object | null
educationAccreditation
object | null
expectedRemuneration
object | null
location
object | null
certifications
(object | null)[]
yearsExperience
object | null
rawText
string

All of the raw text of the parsed job description, example is shortened for readability

Example:

"Human Resources Assistant Switzerland '... <rest of job description text>'"

{key}

For custom fields. E.g. 'isAvailable': true