API documentation TalentScout

Information about the integration of the Exposé Generator.
With verlingo TalentScout you can quickly & easily create high-quality candidate profiles and share them with your customers as interactive web profiles.

Release Date: 10/21


Authentication

Each user of our API receives individual access data. If you are interested in integrating our service, please send us a short email to info@verlingo.de

API Key

You simply specify these credentials as the API key via the HTTP Authorization Header.

HTTP-VERB: ("Authorization", YOUR_API key)

HTTP Status-Codes

Below is a list of the most important HTTP status codes that the verlingo API outputs and how you can interpret them. In general, 200 codes represent a successful request, 400 codes represent an error in the request data (for example, a mandatory parameter is missing), and 500 codes represent an error on our servers.

Code Meaning
200 OK A successful request
400 Bad Request This is usually due to a syntax error in the request body.
401 Unauthorized Incorrect or missing authentication
404 Not Found The resource could not be found
406 Not Acceptable The format of the request is not supported
417 Expectation Failed The transmitted file is not a certificate or the certificate could not be analyzed.
500, 502, 503 Server Error Server error. Repeat the request after a short time and report to us if the error occurs permanently

Create candidates (import)

New candidates can be imported in two ways:

  • on the basis of documents submitted (application documents or similar)
  • on the basis of structured data

Import by means of documents

POST https://recruiting.verlingo.de/api/talentscout/v1/candidates/import/bydocuments
Please note: As format we use JSON, this must be specified by means of the header content type (application/json).
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "Dokuments": {
      {
			"format": "pdf",
			"doc": "base64"
		},
		{
			"format": "jpeg",
			"doc": "base64"
		},
		...
	],
    "Config": {
		"VisibleToAllUsers": boolean (optional)
	},
	"ExternalInfos": {
		"CandidateId": "candidateId (optional)",
		"UserId": "userId (optional)",
		"CustomerId": "customerId (optional)",
		"Additional": {
			Optional user-defined information as JSON
		}
	}
}

The size of the files per request may not exceed 20 MB must not be exceeded. In addition, the files must be stored in a Base64 encoded string and be UTF-8 encoded.

We accept the formats PDF, JPG, JPEG, PNG

The attribute 'ExternalInfos' is optional and is used to store external information about the candidate.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  "message": "Success"
  "CandidateId": "candidateId"
  "EditLink": "editLink"
}

Import via JSON

POST https://recruiting.verlingo.de/api/talentscout/v1/candidates/import/byjson
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "CandidateData": {
        "person": {
            "name": {
                "given": "Marilena",
                "family": "Mustermann",
                "formattedName": "Marilena Mustermann",
                "preferredSalutationCode": "Frau" or "Herr" or ""
            },
            "nationality": "German",
            "maritalStatus": "single",
            "birthDate": "birthDate (any format)",
            "age": "32",
            "placeOfBirth": "Berlin",
            "picture": {
                "imageB64": "base64",
                "format": "jpeg"
            },
            "email": "marilena@email.de",
            "phone": "+49 162 9876543",
            "address": {
                "line": "Bödekerstraße 77",
                "postalCode": "22506",
                "city": "Hamburg",
                "countryCode": "DE",
                "country": "Germany",
                "formattedAddress": "Bödekerstraße 77 22506 Hamburg Germany"
            },
            "summary": "Personal",
            "personalNumber": "Personnel number"
        },
        "job": {
            "jobTitle": "Job title",
            "jobReferenceNumber": "Reference number"
        },
        "employment": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "start": "start",
                "end": "end",
                "location": {
                    "city": "city"
                },
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "sidejobs": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "start": "start",
                "end": "end",
                "location": {
                    "city": "city"
                },
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "internships": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "start": "start",
                "end": "end",
                "location": {
                    "city": "city"
                },
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "education": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "study": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "apprenticeship": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "schooling": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "betterment": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "skills": [
            {
                "name": "name",
                "level": 0 or 1 or 2 or 3 or 4 or 5
            },
            {
                "description": "Subcategory1",
                "content": [
                    {
                        "name": "name",
                        "level": 0 or 1 or 2 or 3 or 4 or 5
                    },
                    ...
                ]
            },
            ...
        ],
        "languages": [
            {
                "language": "language",
                "level": 0 or 1 or 2 or 3 or 4 or 5
            },
            ...
        ],
        "interests": [
            {
                "name": "name"
            },
            ...
        ],
        "certificates": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "rating": 1 - 6
            },
            ...
        ],
        "employmentInfo": {
            "earliestStart": "Available from",
            "desiredSalary": "Income idea",
            "grouping": "Grouping Tariff",
            "costRate": "Charge rate",
            "provision": "Commission",
            "additionalInfo": "Further information",
            "fixum": "Fixed",
            "variableSalary": "Variable salary",
            "companyVehicle": "Company car desired",
            "noticePeriod": "Notice period",
            "move": "Relocation readiness",
            "travel": "Willingness to travel",
            "competion": "Competition clause",
            "motivationToChange": "Motivation to change"
        },
        "contactPersons": {
            "name": "name",
            "email": "email",
            "phone": "phone",
            "avatar": {
                "format": "JPEG",
                "imageB64": "base64"
            }
        },
        "additionalInfos": "Supplementary information"
    },
    "Config": {
        "VisibleToAllUsers": boolean (optional)
    },
    "ExternalInfos": {
        "CandidateId": "candidateId (optional)",
        "UserId": "userId (optional)",
        "CustomerId": "customerId (optional)",
        "Additional": {
            Optional user-defined information as JSON
        }
    }
}

The attribute 'ExternalInfos' is optional and is used to store external information about the candidate.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  "message": "Success"
  "CandidateId": "candidateId"
  "EditLink": "editLink"
}

Update candidates

Candidates can be updated in two ways:

  • on the basis of documents submitted (application documents or similar)
  • using structured data (JSON)

Update by means of documents

PUT https://recruiting.verlingo.de/api/talentscout/v1/candidates/update/bydocuments
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "CandidateId": "candidateId",
	"Documents": [		(optional)
		{
			"format": "pdf",
			"doc": "base64"
		},
		{
			"format": "jpeg",
			"doc": "base64"
		},
		...
	],
	"Config": {
		"VisibleToAllUsers": boolean (optional)
	},
	"ExternalInfos": {
		"CandidateId": "candidateId (optional)",
		"UserId": "userId (optional)",
		"CustomerId": "customerId (optional)",
		"Additional": {
			Optional user-defined information as JSON
		}
	}
}

The size of the files per request may not exceed 20 MB must not be exceeded. In addition, the files must be stored in a Base64 encoded string and be UTF-8 encoded.

We accept the formats PDF, JPG, JPEG, PNG

The 'ExternalInfos' attribute is optional and is used to update external information about the candidate.

A new variant is created in the candidate with the information from the documents.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
    "CandidateId": "candidateId",
	"Variants": [
		{
			"VariantId": "variantId",
			"VariantName": "variantName",
			"CreatedAt": "2021-01-01T14:28:23.234Z",
			"EditLink": "editLink",
			"Sharelinks": [
				{
					"SharelinkId": "sharelinkId",
					"CandidateId": "candidateId",
					"VariantId": "variantId",
					"Customer": "customer",
					"Active": boolean,
					"ContactFormMandatory": boolean,
					"ExternalInfos": externalInfos,
					"CustomerLink": "customerLink",
					"CreatedAt": "2021-01-01T14:28:23.234Z",
					"UpdatedAt": "2021-01-01T14:28:23.234Z",
					"Feedback": [
						{
							"Type": "viewed" or "liked" or "disliked" or "question",
							"Name": "name",
							"Company": "company",
							"Phone": "phone",
							"Email": "email",
							"Question": "question",
							"CreatedAt": "2021-01-01T14:28:23.234Z"
						},
						…
					]
				},
				…
			]
		},
		…
	],
	"VisibleToAllUsers": boolean,
	"ExternalInfos": externalInfos,
	"Status": "status",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z"
}

Update via JSON

PUT https://recruiting.verlingo.de/api/talentscout/v1/candidates/update/byjson
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "CandidateId": "candidateId",
    "CandidateData": {		(optional)
        "person": {
            "name": {
                "given": "Marilena",
                "family": "Mustermann",
                "formattedName": "Marilena Mustermann",
                "preferredSalutationCode": "Frau" or "Herr" or ""
            },
            "nationality": "German",
            "maritalStatus": "single",
            "birthDate": "birthDate (any format)",
            "age": "32",
            "placeOfBirth": "Berlin",
            "picture": {
                "imageB64": "base64",
                "format": "jpeg"
            },
            "email": "marilena@email.de",
            "phone": "+49 162 9876543",
            "address": {
                "line": "Bödekerstraße 77",
                "postalCode": "22506",
                "city": "Hamburg",
                "countryCode": "DE",
                "country": "Germany",
                "formattedAddress": "Bödekerstraße 77 22506 Hamburg Germany"
            },
            "summary": "Personal",
            "personalNumber": "Personnel number"
        },
        "job": {
            "jobTitle": "Job title",
            "jobReferenceNumber": "Reference number"
        },
        "employment": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "start": "start",
                "end": "end",
                "location": {
                    "city": "city"
                },
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "sidejobs": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "start": "start",
                "end": "end",
                "location": {
                    "city": "city"
                },
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "internships": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "start": "start",
                "end": "end",
                "location": {
                    "city": "city"
                },
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "education": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "study": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "apprenticeship": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "schooling": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "betterment": [
            {
                "institution": {
                    "name": "name"
                },
                "location": {
                    "city": "city"
                },
                "area": "area",
                "studyType": "studyType",
                "start": "start",
                "end": "end",
                "graduation": "graduation",
                "graduationGrade": "graduationGrade",
                "info": "info",
                "assignments": [
                    "assignment1",
                    "assignment2",
                    ...
                ]
            },
            ...
        ],
        "skills": [
            {
                "name": "name",
                "level": 0 or 1 or 2 or 3 or 4 or 5
            },
            {
                "description": "Subcategory1",
                "content": [
                    {
                        "name": "name",
                        "level": 0 or 1 or 2 or 3 or 4 or 5
                    },
                    ...
                ]
            },
            ...
        ],
        "languages": [
            {
                "language": "language",
                "level": 0 or 1 or 2 or 3 or 4 or 5
            },
            ...
        ],
        "interests": [
            {
                "name": "name"
            },
            ...
        ],
        "certificates": [
            {
                "organization": {
                    "name": "name"
                },
                "title": "title",
                "rating": 1 - 6
            },
            ...
        ],
        "employmentInfo": {
            "earliestStart": "Available from",
            "desiredSalary": "Income idea",
            "grouping": "Grouping Tariff",
            "costRate": "Charge rate",
            "provision": "Commission",
            "additionalInfo": "Further information",
            "fixum": "Fixed",
            "variableSalary": "Variable salary",
            "companyVehicle": "Company car desired",
            "noticePeriod": "Notice period",
            "move": "Relocation readiness",
            "travel": "Willingness to travel",
            "competion": "Competition clause",
            "motivationToChange": "Motivation to change"
        },
        "contactPersons": {
            "name": "name",
            "email": "email",
            "phone": "phone",
            "avatar": {
                "format": "JPEG",
                "imageB64": "base64"
            }
        },
        "additionalInfos": "Supplementary information"
    },
    "Config": {
        "VisibleToAllUsers": boolean (optional)
    },
    "ExternalInfos": {
        "CandidateId": "candidateId (optional)",
        "UserId": "userId (optional)",
        "CustomerId": "customerId (optional)",
        "Additional": {
            Optional user-defined information as JSON
        }
    }
}

The 'ExternalInfos' attribute is optional and is used to update external information about the candidate.

A new variant is created in the candidate with the information from the "CandidateData" attribute.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  	"CandidateId": "candidateId",
	"Variants": [
		{
			"VariantId": "variantId",
			"VariantName": "variantName",
			"CreatedAt": "2021-01-01T14:28:23.234Z",
			"EditLink": "editLink",
			"Sharelinks": [
				{
					"SharelinkId": "sharelinkId",
					"CandidateId": "candidateId",
					"VariantId": "variantId",
					"Customer": "customer",
					"Active": boolean,
					"ContactFormMandatory": boolean,
					"ExternalInfos": externalInfos,
					"CustomerLink": "customerLink",
					"CreatedAt": "2021-01-01T14:28:23.234Z",
					"UpdatedAt": "2021-01-01T14:28:23.234Z",
					"Feedback": [
						{
							"Type": "viewed" or "liked" or "disliked" or "question",
							"Name": "name",
							"Company": "company",
							"Phone": "phone",
							"Email": "email",
							"Question": "question",
							"CreatedAt": "2021-01-01T14:28:23.234Z"
						},
						…
					]
				},
				…
			]
		},
		…
	],
	"VisibleToAllUsers": boolean,
	"ExternalInfos": externalInfos,
	"Status": "status",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z"
}



Interrogate candidates

GET https://recruiting.verlingo.de/api/talentscout/v1/candidates
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
  "CandidateId": "candidateId"
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  	"CandidateId": "candidateId",
	"Variants": [
		{
			"VariantId": "variantId",
			"VariantName": "variantName",
			"CreatedAt": "2021-01-01T14:28:23.234Z",
			"EditLink": "editLink",
			"Sharelinks": [
				{
					"SharelinkId": "sharelinkId",
					"CandidateId": "candidateId",
					"VariantId": "variantId",
					"Customer": "customer",
					"Active": boolean,
					"ContactFormMandatory": boolean,
					"ExternalInfos": externalInfos,
					"CustomerLink": "customerLink",
					"CreatedAt": "2021-01-01T14:28:23.234Z",
					"UpdatedAt": "2021-01-01T14:28:23.234Z",
					"Feedback": [
						{
							"Type": "viewed" or "liked" or "disliked" or "question",
							"Name": "name",
							"Company": "company",
							"Phone": "phone",
							"Email": "email",
							"Question": "question",
							"CreatedAt": "2021-01-01T14:28:23.234Z"
						},
						…
					]
				},
				…
			]
		},
		…
	],
	"VisibleToAllUsers": boolean,
	"ExternalInfos": externalInfos,
	"Status": "status",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z"
}


Search for candidates

GET https://recruiting.verlingo.de/api/talentscout/v1/candidates/search
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
	"Page": int (optional),
	"Limit": int (optional),
	"ExternalInfos": {
		"CandidateId": "candidateId (optional)",
		"UserId": "userId (optional)",
		"CustomerId": "customerId (optional)"
	}
}

If you specify several ExternalInfos, these are linked with AND in the search.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{
	" docs": [
		{
			"CandidateId": "candidateId",
			"GivenName": "givenName",
			"FamilyName": "familyName",
			"VisibleToAllUsers": boolean,
			"ExternalInfos": externalInfos,
			"CreatedAt": "2021-01-01T14:28:23.234Z",
			"UpdatedAt": "2021-01-01T14:28:23.234Z"
		},
		…
	],
	"total": 6,
	"limit": 3,
	"page": 1,
	"pages": 2
}


Export candidates

GET https://recruiting.verlingo.de/api/talentscout/v1/candidates/export
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
  "CandidateId": "candidateId"
  "ExportAttachments": boolean
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  	{
    "CandidateId": "candidateId",
    "Variants": [
        {
            "meta": {
                "profileId": "variantId",
                "creationDate": "2021-01-01T14:28:23.234Z",
                "profileVariant": "variantName"
            },
            "person": {
                "name": {
                    "given": "Marilena",
                    "family": "Mustermann",
                    "formattedName": "Marilena Mustermann",
                    "preferredSalutationCode": "Frau" or "Herr" or ""
                },
                "nationality": "German",
                "maritalStatus": "ledig",
                "birthDate": "birthDate (any format)",
                "age": "32",
                "placeOfBirth": "Berlin",
                "picture": {
                    "imageB64": "base64",
                    "format": "jpeg"
                },
                "email": "marilena@email.de",
                "phone": "+49 162 9876543",
                "address": {
                    "line": "Bödekerstraße 77",
                    "postalCode": "22506",
                    "city": "Hamburg",
                    "countryCode": "DE",
                    "country": "Germany",
                    "formattedAddress": "Bödekerstraße 77 22506 Hamburg Germany"
                },
                "summary": "Personal",
                "personalNumber": "Personnel number"
            },
            "job": {
                "jobTitle": "Job title",
                "jobReferenceNumber": "Reference number"
            },
            "employment": [
                {
                    "organization": {
                        "name": "name"
                    },
                    "title": "title",
                    "start": "start",
                    "end": "end",
                    "location": {
                        "city": "city"
                    },
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "sidejobs": [
                {
                    "organization": {
                        "name": "name"
                    },
                    "title": "title",
                    "start": "start",
                    "end": "end",
                    "location": {
                        "city": "city"
                    },
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "internships": [
                {
                    "organization": {
                        "name": "name"
                    },
                    "title": "title",
                    "start": "start",
                    "end": "end",
                    "location": {
                        "city": "city"
                    },
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "education": [
                {
                    "institution": {
                        "name": "name"
                    },
                    "location": {
                        "city": "city"
                    },
                    "area": "area",
                    "studyType": "studyType",
                    "start": "start",
                    "end": "end",
                    "graduation": "graduation",
                    "graduationGrade": "graduationGrade",
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "study": [
                {
                    "institution": {
                        "name": "name"
                    },
                    "location": {
                        "city": "city"
                    },
                    "area": "area",
                    "studyType": "studyType",
                    "start": "start",
                    "end": "end",
                    "graduation": "graduation",
                    "graduationGrade": "graduationGrade",
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "apprenticeship": [
                {
                    "institution": {
                        "name": "name"
                    },
                    "location": {
                        "city": "city"
                    },
                    "area": "area",
                    "studyType": "studyType",
                    "start": "start",
                    "end": "end",
                    "graduation": "graduation",
                    "graduationGrade": "graduationGrade",
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "schooling": [
                {
                    "institution": {
                        "name": "name"
                    },
                    "location": {
                        "city": "city"
                    },
                    "area": "area",
                    "studyType": "studyType",
                    "start": "start",
                    "end": "end",
                    "graduation": "graduation",
                    "graduationGrade": "graduationGrade",
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "betterment": [
                {
                    "institution": {
                        "name": "name"
                    },
                    "location": {
                        "city": "city"
                    },
                    "area": "area",
                    "studyType": "studyType",
                    "start": "start",
                    "end": "end",
                    "graduation": "graduation",
                    "graduationGrade": "graduationGrade",
                    "info": "info",
                    "assignments": [
                        "assignment1",
                        "assignment2",
                        ...
                    ]
                },
                ...
            ],
            "skills": [
                {
                    "name": "name",
                    "level": 0 or 1 or 2 or 3 or 4 or 5
                },
                {
                    "description": "Subcategory1",
                    "content": [
                        {
                            "name": "name",
                            "level": 0 or 1 or 2 or 3 or 4 or 5
                        },
                        ...
                    ]
                },
                ...
            ],
            "languages": [
                {
                    "language": "language",
                    "level": 0 or 1 or 2 or 3 or 4 or 5
                },
                ...
            ],
            "interests": [
                {
                    "name": "name"
                },
                ...
            ],
            "certificates": [
                {
                    "organization": {
                        "name": "name"
                    },
                    "title": "title",
                    "rating": 1 - 6,
                    "attachmentID": "attachmentID" (Reference to the corresponding attachment)
                },
                ...
            ],
            "employmentInfo": {
                "earliestStart": "Available from",
                "desiredSalary": "Income idea",
                "grouping": "Grouping Tariff",
                "costRate": "Charge rate",
                "provision": "Commission",
                "additionalInfo": "Further information",
                "fixum": "Fixed",
                "variableSalary": "Variable salary",
                "companyVehicle": "Company car desired",
                "noticePeriod": "Notice period",
                "move": "Relocation readiness",
                "travel": "Willingness to travel",
                "competion": "Competition clause",
                "motivationToChange": "Motivation to change"
            },
            "contactPersons": {
                "name": "name",
                "email": "email",
                "phone": "phone",
                "avatar": {
                    "format": "JPEG",
                    "imageB64": "base64"
                }
            },
            "additionalInfos": "Supplementary information"
        },
        ...
    ],
    "Attachments": [
        {
            "type": "Cover page",
            "content": [
                {
                    "pages": [
                        {
                            "imageB64": "base64",
                            "format": "jpeg",
                            "ImageHeight": 3508,
                            "ImageWidth": 2481,
                            "paragraphs": [
                                {
                                    "CropNo": 1,
                                    "x": 840.2018244013683,
                                    "xEndpoint": 1639.3836944127706,
                                    "y": 2376.843208383716,
                                    "yEndpoint": 2470.1636436920594,
                                    "width": 799.1818700114025,
                                    "height": 93.32043530834335,
                                    "scaleY": 0.7072405929304447,
                                    "scaleX": 0.7069729947601774,
                                    "Text": "Word1 Word2\n",
                                    "TextConfidence": 93,
                                    "words": [
                                        {
                                            "x": 22.631698973774228,
                                            "y": 22.623135832325673,
                                            "w": 295.6265678449259,
                                            "h": 57.97178557033454,
                                            "text": "Word1",
                                            "confidence": 91
                                        },
                                        {
                                            "x": 343.7189281641961,
                                            "y": 28.278919790407095,
                                            "w": 432.83124287343213,
                                            "h": 52.316001612253125,
                                            "text": "Word2",
                                            "confidence": 96
                                        }
                                    ],
                                    "textlines": [
                                        {
                                            "text": "Word1 Word2\n\n",
                                            "confidence": 93,
                                            "fontsize": 29,
                                            "x": 8.486887115165336,
                                            "y": 8.483675937122127,
                                            "w": 782.2080957810718,
                                            "h": 84.83675937122128
                                        }
                                    ]
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "id": "attachmentID"
                },
                ...
            ]
        },
        {
            "type": "Cover letter",
            "content": [
                {
                    "pages": [
                        {
                            "imageB64": "base64",
                            "format": "jpeg",
                            "ImageHeight": 3508,
                            "ImageWidth": 2481,
                            "paragraphs": [
                                {
                                    "CropNo": 1,
                                    "x": 840.2018244013683,
                                    "xEndpoint": 1639.3836944127706,
                                    "y": 2376.843208383716,
                                    "yEndpoint": 2470.1636436920594,
                                    "width": 799.1818700114025,
                                    "height": 93.32043530834335,
                                    "scaleY": 0.7072405929304447,
                                    "scaleX": 0.7069729947601774,
                                    "Text": "Word1 Word2\n",
                                    "TextConfidence": 93,
                                    "words": [
                                        {
                                            "x": 22.631698973774228,
                                            "y": 22.623135832325673,
                                            "w": 295.6265678449259,
                                            "h": 57.97178557033454,
                                            "text": "Word1",
                                            "confidence": 91
                                        },
                                        {
                                            "x": 343.7189281641961,
                                            "y": 28.278919790407095,
                                            "w": 432.83124287343213,
                                            "h": 52.316001612253125,
                                            "text": "Word2",
                                            "confidence": 96
                                        }
                                    ],
                                    "textlines": [
                                        {
                                            "text": "Word1 Word2\n\n",
                                            "confidence": 93,
                                            "fontsize": 29,
                                            "x": 8.486887115165336,
                                            "y": 8.483675937122127,
                                            "w": 782.2080957810718,
                                            "h": 84.83675937122128
                                        }
                                    ]
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "id": "attachmentID"
                },
                ...
            ]
        },
        {
            "type": "Resume",
            "content": [
                {
                    "pages": [
                        {
                            "imageB64": "base64",
                            "format": "jpeg",
                            "ImageHeight": 3508,
                            "ImageWidth": 2481,
                            "paragraphs": [
                                {
                                    "CropNo": 1,
                                    "x": 840.2018244013683,
                                    "xEndpoint": 1639.3836944127706,
                                    "y": 2376.843208383716,
                                    "yEndpoint": 2470.1636436920594,
                                    "width": 799.1818700114025,
                                    "height": 93.32043530834335,
                                    "scaleY": 0.7072405929304447,
                                    "scaleX": 0.7069729947601774,
                                    "Text": "Word1 Word2\n",
                                    "TextConfidence": 93,
                                    "words": [
                                        {
                                            "x": 22.631698973774228,
                                            "y": 22.623135832325673,
                                            "w": 295.6265678449259,
                                            "h": 57.97178557033454,
                                            "text": "Word1",
                                            "confidence": 91
                                        },
                                        {
                                            "x": 343.7189281641961,
                                            "y": 28.278919790407095,
                                            "w": 432.83124287343213,
                                            "h": 52.316001612253125,
                                            "text": "Word2",
                                            "confidence": 96
                                        }
                                    ],
                                    "textlines": [
                                        {
                                            "text": "Word1 Word2\n\n",
                                            "confidence": 93,
                                            "fontsize": 29,
                                            "x": 8.486887115165336,
                                            "y": 8.483675937122127,
                                            "w": 782.2080957810718,
                                            "h": 84.83675937122128
                                        }
                                    ]
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "id": "attachmentID"
                },
                ...
            ]
        },
        {
            "type": "Job reference",
            "content": [
                {
                    "pages": [
                        {
                            "imageB64": "base64",
                            "format": "jpeg",
                            "ImageHeight": 3508,
                            "ImageWidth": 2481,
                            "paragraphs": [
                                {
                                    "CropNo": 1,
                                    "x": 840.2018244013683,
                                    "xEndpoint": 1639.3836944127706,
                                    "y": 2376.843208383716,
                                    "yEndpoint": 2470.1636436920594,
                                    "width": 799.1818700114025,
                                    "height": 93.32043530834335,
                                    "scaleY": 0.7072405929304447,
                                    "scaleX": 0.7069729947601774,
                                    "Text": "Word1 Word2\n",
                                    "TextConfidence": 93,
                                    "words": [
                                        {
                                            "x": 22.631698973774228,
                                            "y": 22.623135832325673,
                                            "w": 295.6265678449259,
                                            "h": 57.97178557033454,
                                            "text": "Word1",
                                            "confidence": 91
                                        },
                                        {
                                            "x": 343.7189281641961,
                                            "y": 28.278919790407095,
                                            "w": 432.83124287343213,
                                            "h": 52.316001612253125,
                                            "text": "Word2",
                                            "confidence": 96
                                        }
                                    ],
                                    "textlines": [
                                        {
                                            "text": "Word1 Word2\n\n",
                                            "confidence": 93,
                                            "fontsize": 29,
                                            "x": 8.486887115165336,
                                            "y": 8.483675937122127,
                                            "w": 782.2080957810718,
                                            "h": 84.83675937122128
                                        }
                                    ]
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "id": "attachmentID"
                },
                ...
            ]
        },
        {
            "type": "Testimonials/Certificates",
            "content": [
                {
                    "pages": [
                        {
                            "imageB64": "base64",
                            "format": "jpeg",
                            "ImageHeight": 3508,
                            "ImageWidth": 2481,
                            "paragraphs": [
                                {
                                    "CropNo": 1,
                                    "x": 840.2018244013683,
                                    "xEndpoint": 1639.3836944127706,
                                    "y": 2376.843208383716,
                                    "yEndpoint": 2470.1636436920594,
                                    "width": 799.1818700114025,
                                    "height": 93.32043530834335,
                                    "scaleY": 0.7072405929304447,
                                    "scaleX": 0.7069729947601774,
                                    "Text": "Word1 Word2\n",
                                    "TextConfidence": 93,
                                    "words": [
                                        {
                                            "x": 22.631698973774228,
                                            "y": 22.623135832325673,
                                            "w": 295.6265678449259,
                                            "h": 57.97178557033454,
                                            "text": "Word1",
                                            "confidence": 91
                                        },
                                        {
                                            "x": 343.7189281641961,
                                            "y": 28.278919790407095,
                                            "w": 432.83124287343213,
                                            "h": 52.316001612253125,
                                            "text": "Word2",
                                            "confidence": 96
                                        }
                                    ],
                                    "textlines": [
                                        {
                                            "text": "Word1 Word2\n\n",
                                            "confidence": 93,
                                            "fontsize": 29,
                                            "x": 8.486887115165336,
                                            "y": 8.483675937122127,
                                            "w": 782.2080957810718,
                                            "h": 84.83675937122128
                                        }
                                    ]
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "id": "attachmentID"
                },
                ...
            ]
        },
        {
            "type": "Other",
            "content": [
                {
                    "pages": [
                        {
                            "imageB64": "base64",
                            "format": "jpeg",
                            "ImageHeight": 3508,
                            "ImageWidth": 2481,
                            "paragraphs": [
                                {
                                    "CropNo": 1,
                                    "x": 840.2018244013683,
                                    "xEndpoint": 1639.3836944127706,
                                    "y": 2376.843208383716,
                                    "yEndpoint": 2470.1636436920594,
                                    "width": 799.1818700114025,
                                    "height": 93.32043530834335,
                                    "scaleY": 0.7072405929304447,
                                    "scaleX": 0.7069729947601774,
                                    "Text": "Word1 Word2\n",
                                    "TextConfidence": 93,
                                    "words": [
                                        {
                                            "x": 22.631698973774228,
                                            "y": 22.623135832325673,
                                            "w": 295.6265678449259,
                                            "h": 57.97178557033454,
                                            "text": "Word1",
                                            "confidence": 91
                                        },
                                        {
                                            "x": 343.7189281641961,
                                            "y": 28.278919790407095,
                                            "w": 432.83124287343213,
                                            "h": 52.316001612253125,
                                            "text": "Word2",
                                            "confidence": 96
                                        }
                                    ],
                                    "textlines": [
                                        {
                                            "text": "Word1 Word2\n\n",
                                            "confidence": 93,
                                            "fontsize": 29,
                                            "x": 8.486887115165336,
                                            "y": 8.483675937122127,
                                            "w": 782.2080957810718,
                                            "h": 84.83675937122128
                                        }
                                    ]
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "id": "attachmentID"
                },
                ...
            ]
        }
    ],
    "ExternalInfos": externalInfos,
    "Status": "status",
    "CreatedAt": "2021-01-01T14:28:23.234Z",
    "UpdatedAt": "2021-01-01T14:28:23.234Z"
}


Delete candidates

DELETE https://recruiting.verlingo.de/api/talentscout/v1/candidates
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
  "CandidateId": "candidateId"
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  "message": "Candidate successfully deleted."
}

Delete exposé variant

DELETE https://recruiting.verlingo.de/api/talentscout/v1/candidates/variants
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
  "CandidateId": "candidateId"
  "VariantId": "variantId"
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  "message": "Variant and related sharelinks successfully deleted."
}

Update variant

Exposé variants can be updated in the following ways:

  • on the basis of documents submitted (application documents or similar)

Update by means of documents

PUT https://recruiting.verlingo.de/api/talentscout/v1/candidates/variants/update/bydocuments
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
	"CandidateId": "candidateId",
	"Documents": [
		{
			"format": "pdf",
			"doc": "base64"
		},
		{
			"format": "jpeg",
			"doc": "base64"
		},
		...
	],
	"VariantId": "variantId"
}


The size of the files per request may not exceed 20 MB must not be exceeded. In addition, the files must be stored in a Base64 encoded string and be UTF-8 encoded.

We accept the formats PDF, JPG, JPEG, PNG

The corresponding variant is supplemented with the extracted information from the documents; the original data is not overwritten.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{
	"CandidateId": "candidateId",
	"Variants": [
		{
			"VariantId": "variantId",
			"VariantName": "variantName",
			"CreatedAt": "2021-01-01T14:28:23.234Z",
			"EditLink": "editLink",
			"Sharelinks": [
				{
					"SharelinkId": "sharelinkId",
					"CandidateId": "candidateId",
					"VariantId": "variantId",
					"Customer": "customer",
					"Active": boolean,
					"ContactFormMandatory": boolean,
					"ExternalInfos": externalInfos,
					"CustomerLink": "customerLink",
					"CreatedAt": "2021-01-01T14:28:23.234Z",
					"UpdatedAt": "2021-01-01T14:28:23.234Z",
					"Feedback": [
						{
							"Type": "viewed" or "liked" or "disliked" or "question",
							"Name": "name",
							"Company": "company",
							"Phone": "phone",
							"Email": "email",
							"Question": "question",
							"CreatedAt": "2021-01-01T14:28:23.234Z"
						},
						…
					]
				},
				…
			]
		},
		…
	],
	"VisibleToAllUsers": boolean,
	"ExternalInfos": externalInfos,
	"Status": "status",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z"
}

 

Create exposé link (share link)

POST https://recruiting.verlingo.de/api/talentscout/v1/sharelinks
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "CandidateId": "candidateId",
	"VariantId": "variantId",
    "Customer": "customer",
	"Config": {
		"ContactFormMandatory": boolean (optional)
	},
	"ExternalInfos": {
		"CandidateId": "candidateId (optional)",
		"UserId": "userId (optional)",
		"CustomerId": "customerId (optional)",
		"Additional": {
			Optional user-defined information as JSON
		}
	}
}

The 'ExternalInfos' attribute is optional and is used to store external information about the sharelink.

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
    "SharelinkId": "sharelinkId",
	"CandidateId": "candidateId",
	"VariantId": "variantId",
    "Customer": "customer",
	"Active": boolean,
	"ContactFormMandatory": boolean,
	"ExternalInfos": externalInfos,
	"CustomerLink": "customerLink",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z"
}

Request Exposélink (Sharelink)

GET https://recruiting.verlingo.de/api/talentscout/v1/sharelinks
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "SharelinkId": "sharelinkId"
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
    "SharelinkId": "sharelinkId",
	"CandidateId": "candidateId",
	"VariantId": "variantId",
	"Customer": "customer",
	"Active": boolean,
	"ContactFormMandatory": boolean,
	"ExternalInfos": externalInfos,
	"CustomerLink": "customerLink",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z",
	"Feedback": [
		{
			"Type": "viewed" or "liked" or "disliked" or "question",
			"Name": "name",
			"Company": "company",
			"Phone": "phone",
			"Email": "email",
			"Question": "question",
			"CreatedAt": "2021-01-01T14:28:23.234Z"
		},
		…
	]
}

The feedback of the customer to the candidate is sorted from new to old and the attributes depend on the type and configuration.


Update exposé link (share link)

PUT https://recruiting.verlingo.de/api/talentscout/v1/sharelinks
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
    "SharelinkId": "sharelinkId",
	"Customer": "customer",
	"Config": {
		"ContactFormMandatory": boolean (optional),
		"Active": boolean (optional)
	},
	"ExternalInfos": {
		"CandidateId": "candidateId (optional)",
		"UserId": "userId (optional)",
		"CustomerId": "customerId (optional)",
		"Additional": {
			Optional user-defined information as JSON
		}
	}
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
    "SharelinkId": "sharelinkId",
	"CandidateId": "candidateId",
	"VariantId": "variantId",
	"Customer": "customer",
	"Active": boolean,
	"ContactFormMandatory": boolean,
	"ExternalInfos": externalInfos,
	"CustomerLink": "customerLink",
	"CreatedAt": "2021-01-01T14:28:23.234Z",
	"UpdatedAt": "2021-01-01T14:28:23.234Z",
	"Feedback": [
		{
			"Type": "viewed" or "liked" or "disliked" or "question",
			"Name": "name",
			"Company": "company",
			"Phone": "phone",
			"Email": "email",
			"Question": "question",
			"CreatedAt": "2021-01-01T14:28:23.234Z"
		},
		…
	]
}

The feedback of the customer to the candidate is sorted from new to old and the attributes depend on the type and configuration.


Delete exposé link (share link)

DELETE https://recruiting.verlingo.de/api/talentscout/v1/sharelinks
Request

http-Header:

"Content-Type": "application/json"
"Authorization": YOUR_API key

http-Body:

{
  "SharelinkId": "sharelinkId"
}
Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

{ 
  "message": "Sharelink successfully deleted."
}
Icon For Arrow-up