Applicant Detail Page

This endpoint allows you to generate a cryptographically secured and verification-free link to a candidate's detail page, which can be embedded within other applications or websites.

HTTP Request

• Method: POST
• URL: https://api.vinter.me/api/v1/Application/CreateApplicationResultLink

Request Headers

Header Name	Description	Example Value
X-Api-Key	API key for organizational authentication.	api_key
Content-Type	Specifies the media type of the request body.	application/json

Request Body Parameters

Parameter Name	Type	Required	Description	Example Value
invitationId	String	Yes	The invitation ID associated with the candidate.	cb9eaf83-bf12-4136-b2b5-635a016594d2

Example Request Body

{
  "invitationId": "cb9eaf83-bf12-4136-b2b5-635a016594d2"
}

Response Format

Upon a successful request, the following JSON structure is returned:

{
  "data": null,
  "success": true,
  "message": "https://app.vinter.me/applicant-crypted/detail?crypted=dAsPTl%2fQ2xNvcOop5r8zH38GCcG4c%2fN1iyv%2fxl1gPT%2fmUeATL2iPD0BLhmulXpJID4bmxixIlGPWVZkKhlvCKWGgywZ6sbD%2bqnc6q2aZBcUNZPl7",
  "isResourceKey": true
}

Error Codes

HTTP Code	Status	Description
400	Bad Request	The request contains invalid or missing parameters.
401	Unauthorized	Authentication failed due to a missing or invalid API key.
404	Not Found	The requested resource could not be found.
500	Internal Error	An internal server error occurred.

Detailed Explanation

This endpoint serves a critical function within an integrated hiring platform. By providing a secure, cryptographically protected link, it allows authorized users to seamlessly access candidate details without additional verification steps. This is particularly useful in scenarios where third-party systems, such as applicant tracking systems or custom dashboards, need a simple yet secure means of embedding candidate data.

Key Features:

1. Cryptographic Security: The generated link is encrypted to ensure the data remains tamper-proof and confidential.
2. Verification-Free Access: Once the link is generated, no further authentication is required on the client side, reducing complexity and improving user experience.
3. Easy Integration: Designed to work seamlessly with other applications, this endpoint simplifies the integration process for developers and HR professionals.

Use Cases:

• Recruitment Dashboards: HR teams can quickly embed secure candidate links in their internal dashboards.
• Third-Party Integrations: External systems can display candidate details directly without building complex authentication mechanisms.
• Streamlined Processes: Reduce the need for repeated authentication and manual data sharing, increasing efficiency across recruitment operations.

Best Practices:

• Protect the API Key: Ensure that the X-Api-Key is stored securely and never shared publicly.
• Handle Errors Gracefully: Implement error-handling logic to manage potential issues, such as missing or invalid parameters.
• Monitor Usage: Track the number of requests and response times to identify and resolve any performance bottlenecks.

By following these guidelines and leveraging the endpoint’s capabilities, organizations can maintain a secure, efficient, and user-friendly process for accessing candidate details.