API Reference

Create analysis candidate

post
https://api.joinpopp.com/v1/analysis/candidates

Creates an analysis candidate

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The input to create an analysis candidate

Either analysisId or externalAnalysisId is required.

string
required

The unique identifier for the analysis.

string

The unique identifier for the analysis in the external system.

uri

The URL of the document to analyze. Must be a valid URL.

string

The base64-encoded content of the document to analyze.

string

The first name of the candidate.

string

The last name of the candidate.

string

The phone number of the candidate in E.164 format.

string

The email address of the candidate.

string

The unique identifier for the candidate in the external system.

string
enum
Defaults to cv

The type of document being uploaded. Defaults to 'cv'.

Allowed:
Responses

Updated 16 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago