pen-to-squareLogin

Login Endpoint

To obtain an access token that grants access to other resources, make a request to the login endpoint as follows:

Method: POST

Response: On successful authentication, the server responds with a JSON object containing an access token:

post
Header parameters
X-CLIENTIDstringRequired

Client identifier for the API.

Example: sdfgfd-sdfgf4d-sdfgfdsd-sdfgfds
Body
emailstring · emailOptional

The email address of the user.

Example: test@example.com
public_keystringOptional

The client public key.

Example: sdfgfd-sdfgf4d-sdfgfdsd-sdfgfds
secret_keystringOptional

The client secret key.

Example: sdfgfd-sdfgf4d-sdfgfdsd-sdfgfds
Responses
chevron-right
200

Successful login

application/json
accessstringOptional

The access token for the session.

refreshstringOptional

The refresh token for the session.

post
/v1/identity/login/

Last updated