​
Error delivery

​
URL Query

Vital performs a 307 Temporary Redirect to the redirect_url specified in your Link Token in the following scenarios: Error parameters would be appended to the redirect_url before the redirection. For example, given a redirect_url of https://example.com/vital/callback: 
https://example.com/vital/callback
?state=error
&error_type=provider_credential_error
&error=Invalid%20username%20or%20password

​
JSON Response

Vital responds 200 OK with a JSON response in the following scenarios: Error parameters would be embedded into the JSON response. For example: 
{
  "state": "error",
  "error_type": "provider_credential_error",
  "error": "Invalid username or password"
}

​
Error Parameters

​
state
const string
Constant: error
​
error_type
string
One of the Link Error Types.
​
error
string
A human-readable error explanation for troubleshooting purposes. Your application logic should not rely on this message.

​
Error Types

This list is non-exhaustive. Your application logic must gracefully handle any unrecognized error type.
Error TypeDescription
invalid_tokenThe Link Token is invalid or malformed.
token_expiredThe Link Token has expired.
token_consumedA successful connection establishment had consumed this Link Token.
provider_credential_error
  • OAuth: An error occurred during the provider authentication flow.
  • Password & Email: The supplied user credential is invalid.
provider_password_expiredThe supplied password has expired due to the password rotation policy of the provider. The user must rotate their password directly with the provider before trying to connect again.
Applicable only to the patient-based abbott_libreview integration.
provider_api_errorAn unexpected error occurred when Junction Link attempts to connect to the provider API.
unsupported_regionThe region you specified is not supported.
Applicable only the practice-based freestyle_libre integration.
duplicate_connectionThe provider credential has an existing connection to a different user in your team.
Applicable only if you have opted in to the reject_duplicate_connection team setting.
required_scopes_not_grantedUser did not grant all required scopes, so Vital cannot establish the connection.
incorrect_mfa_codeThe MFA code entered is incorrect.