Applicant Magic Link Authentication

This endpoint allows you to generate a secure applicant magic link that can be used for logging in without a traditional password. The link is active for a limited time and provides a streamlined user experience.

---

HTTP Request

• Method: POST
• URL:
  https://api.vinter.me/api/v1/Auth/CreateApplicantMagicLink

---

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.	application/json

---

Request Body

The following fields must be included in the request body:

Parameter Name	Type	Required	Description
firstName	String	Yes	The user’s first name.
lastName	String	Yes	The user’s last name.
email	String	Yes	The user’s email address.
phone	String	Yes	The user’s phone number.
languageCode	String	Yes	The preferred language for communication.
mailPermission	Boolean	Yes	Consent for receiving email notifications.
positionId	String	Yes	Position identifier.

Example Request Body

{
  "firstName": "Musa",
  "lastName": "ERTEK",
  "email": "[email protected]",
  "phone": "+905555555555",
  "languageCode": "tr-TR",
  "mailPermission": true,
  "positionId": "727df810-bb41-4751-98c8-e8f81c5a69f2"
}

---

Response Format

Upon request, a new MagicLink will be returned. The MagicLink is valid for a limited time.

Example Response Body

{
  "Data": {
    "MagicLink": "https://applicant.vinter.me/loginWithKey?apiKey=BFflidn6j2yTh7ul2pLmpw==:wQLz9jG/T0j6nNHfMCnBMJrekhDaYj6TG5lQ+ikHDcyXcbODkg0wo8wmaFt6isAyzjQWxpRS7P569Cz/GT7sDBKSLy1O03Hca/aaR9ilY20znmDtDCeSGoIm0qUf88s9M+NDQJ0EiF37A+wxmUSj0Es2LZgsvvUVgQzxRvqZnTUzLuD6FRvUV0SGyFkdWN5udZPcbRD3g3ilrtc/60BKhGsK1R81ogCO/pUj7RAH6cNkcbShtLry/4f5+fMRi6NQ"
  },
  "Success": true,
  "Message": null,
  "IsResourceKey": true
}

---

Detailed Field Descriptions

• MagicLink:
  A secure link for logging in. Valid for a limited time.

• Success:
  Indicates whether the request was successfully processed.

• Message:
  Any additional information or error messages.

• IsResourceKey:
  A flag indicating if the response contains a resource key.

---

Use Cases

• Passwordless Login:
  Provide users with a fast and secure way to log in without remembering passwords.

• Secure Access Control:
  Ensure only authorized individuals can generate a valid magic link.

• Streamlined Onboarding:
  New users can easily set up their accounts and log in using the magic link, reducing the friction of traditional registration processes.

---