メインコンテンツまでスキップ

Company Sign In

Validates whether a company's API key is valid, with an optional username that must align with the associated company API key

EndPoint

Use Authentication API base URL

POST /api/auth/company

Permission

None (public endpoint)

Request Header

NameData TypeDescription
Content-Typestringapplication/json
ApiKeystringString (128). The ApiKey of the Company

Query Param

No Query Param

Request Body

No Request Body

Response Example

On a successful request, the API returns an HTTP 200 OK status with a JSON object containing the submission details.

HTTP/1.1 200 OK
Content-Type: application/json

{
"submissionStatus": "success",
"reason": "",
"message": "",
"submissionObject": {
"accessToken": "String",
"refreshToken": "String",
"accessTokenExpiryInSecond": 0000000,
"createdUtcDate": "0000-00-00T00:00:00.000000+00:00",
"userName": "String"
},
"isSubmissionSuccess": true
}