Skip to main content

Create Access Token for Login

POST 
/v1/auth/signin

Generate an Access Token by providing your API ID and API Key in the request body. Use the Access Token to authenticate and log in to the application via the 'Authorize' section.

Request​

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Body

required

Create an Access Token requires an API ID and Api Key.

    api_id stringrequired

    User defined apiId.

    api_key stringrequired

    User defined apiKey.

Responses​

User authenticated successfully.

Schema
    access_token stringrequired

    JWT access token. Token used to access all protected endpoints.

Loading...