Auth Token Generation API

API for generating a short lived auth token to be used in Convin's Lead Ingestion API request

Auth Token Generation API

To send leads to Convin using the Lead Ingestion API, customers must first generate an Auth Token. This token is required in the Authorization header of all subsequent Lead Ingestion API requests.

Generate Auth Token

Use the following endpoint to generate an authentication token:

Endpoint:
POST https://<your-org-id>.api.convin.ai/person/auth/token/

Request Headers:

Content-Type: application/json

Request Body:

{ "username": "[email protected]", "password": "password" }

cURL Example:

curl --location 'https://<your-org-id>.api.convin.ai/person/auth/token/' \

--header 'Content-Type: application/json' \

--data-raw '{

    "username": "[email protected]",

    "password": "password"

}'

Any active Convin user’s username and password can be used to generate this token.

Token Details

  • Validity: 10 minutes

  • Rate Limit: 120 requests per minute

  • Purpose: Must be included in all requests made to Convin’s Lead Ingestion API

Response Examples

Success – 200

{   "token": "***" }

Unauthorized – 401

Invalid Username

{ "error": "Invalid username" }

Incorrect Password

{ "error": "Invalid password." }


Was this article helpful?