POST
/
login
curl --request POST \
  --url https://gateway.finhub.cloud/customer/login \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenantId: <tenantid>' \
  --data '{
  "credentials": [
    {
      "credentialType": "email",
      "value": "<string>",
      "code": "<string>",
      "communicationChannel": {
        "name": "<string>",
        "type": "phone",
        "addressUrl": "<string>"
      }
    }
  ]
}'
[
  {
    "userId": "<string>",
    "customerId": "<string>",
    "personId": "<string>",
    "tenantId": "<string>",
    "organizationId": "<string>",
    "credentials": [
      {
        "sessionId": "<string>",
        "value": "<string>",
        "token": "<string>"
      }
    ],
    "twoFaInfo": [
      {
        "id": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "tenantId": "<string>",
        "login": true,
        "trading": true,
        "funding": true,
        "userId": "<string>"
      }
    ]
  }
]

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

tenantId
string
required

Tenant/Owner id

Body

application/json
credentials
object[]

Response

200 - application/json
userId
string
customerId
string
personId
string
tenantId
string
organizationId
string
credentials
object[]
twoFaInfo
object[]