/
POST - /pin

POST - /pin

Owned by Fadi Nasr (Unlicensed)
Last updated: Mar 04, 2020 by antoine hage

General Information

ServiceAPIMethodData ModelsWorkflow
oauth/pinPOSTN/AN/A

Description

This API allows the user to login with pin.

Input

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
pinBodyNOStringN/APin
grant_typeBodyYESString

"enum": ["refresh_token", "password"]

Grant Type
refresh_tokenBodyNOStringN/ARefresh token

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Valid Response Sample 
{
    "token_type": "bearer",
    "access_token": "%oauth_access_token_value%",
    "expires_in": 3600,
    "refresh_token": "%oauth_refresh_token_value%"
}

Invalid Response

Error Response Sample 
{
    "result":false,
    "errors":{
        "codes":[406],
        "details":[
            {
                "code":406,
                "message":"Missing Tenant secret"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code
Description
406

Missing Tenant secret

503

Pin login is not available for this account

Related content