Skip to the content
Get an API key
  1. API reference
  2. Connect your users

Poll the sign-in status

GET/app/integrations/byUniqueId/{uniqueId}
Core + Managed TransfersAuthNo credential

Poll this while a sign-in that you started with uniqueId runs. It needs no credentials: the uniqueId you chose is the secret. Send tokenOnly=1 from a browser, so the answer never holds music-service credentials.

Path parameters

uniqueId
uuidrequired

The UUID v4 that you passed as uniqueId when you started the sign-in.

Query parameters

tokenOnly
boolean · false

Leave authData out of the answer.

Response

200application/json · AuthByUniqueIdResponseOK
authModel
AuthModel
required
authModel.uuid
uuid
required
authModel.status
string
requiredOne of: initialised, success, error
authModel.error
string | null
required
authModel.errorType
string | null
requiredOne of: accessDenied, notAllowedInYourCountry, missingScopes, deniedSubscriptionTier, null
oneTimeToken
string | null
requiredA one-time token for this login, when the login asked for one (requestOneTimeToken=true).
integrationUser
IntegrationUserWithAuthData | null
requiredThe connected user once the login succeeded. authData is present only when the login asked for a one-time token, the call has no tokenOnly=1, and the return URL is not an http(s) URL.
integrationUser.uuid
uuid
requiredThe integrationUserUUID. Use it in every /api/{integrationUserUUID}/... call.
integrationUser.integrationUserId
string
requiredThe user's id on the music service.
integrationUser.name
string | null
required
integrationUser.email
string | null
required
integrationUser.imageUrl
string | null
required
integrationUser.country
string | null
requiredISO 3166-1 alpha-2 country of the account, when the service tells us.
integrationUser.authData
object
The raw music-service credentials, without the refresh token. Only in answers to a Client Secret (Basic) or one-time-token call.
integrationUser.authDataExpiresAt
number | null
When authData expires, in milliseconds since the epoch.
Example answer
{
  "authModel": {
    "uuid": "5b0c6f0e-2c8a-4d0e-9a51-7e3f1c2d9b44",
    "status": "initialised",
    "error": "string",
    "errorType": "accessDenied"
  },
  "oneTimeToken": "string",
  "integrationUser": {
    "uuid": "3f0b8c1e-6a4d-4c7a-9a55-2f1e7d9b0c11",
    "integrationUserId": "mica.nowak",
    "name": "Mica Nowak",
    "email": "[email protected]",
    "imageUrl": "https://images.example.com/mica.jpg",
    "country": "PL",
    "authData": {},
    "authDataExpiresAt": 0
  }
}

Errors

404

No sign-in with this uniqueId.