user/sign-in - Docs - InfinityFX™ API

Sign inGet an access and refresh token associated with an IFX ID using it's associated email address and password. The provided access token will be valid for 10 minutes, where as the refresh token stays valid for 7 days. In case 2 factor authentication is enabled for the given IFX ID, a partial response is sent.Request

POST/user/sign-in

Parameters

NamePlaceTypeDescriptionRequiredDefault

Content-TypeHeaderStringYesNone

emailBodyStringThe IFX ID's associated email address.YesNone

passwordBodyStringThe IFX ID's associated password.YesNone

silentBodyBooleanWhether to always respond with a 200 OK status code, regardless of the actual response body.NoFalse

Example

JavaScript

cURL

1
2
3
4
5
6
7
8
9
10
const
 response
 = await
 fetch
('https://api.infinity-fx.com/user/sign-in'
, {
method
: 'POST'
,
headers
: {
'Content-Type'
: 'application/json'

},
body
: JSON
.stringify
({
email
: 'YOUR_EMAIL'
,
password
: 'YOUR_PASSWORD'

})
});

Responses

Parameters

NameTypeValueDescription

StatusInt200OK

Bodyapplication/jsonaccess_tokenStringA JWT that can be used as a Bearer authorization token, which is valid for 10 minutes.refresh_tokenStringA secure token used to refresh expired access tokens, which itself expires on session loss or after 7 days.

Examples

1
2
3
4
{
"access_token"
: "YOUR_ACCESS_TOKEN"

"refresh_token"
: "YOUR_REFRESH_TOKEN"

}