Connecting Providers
Link Errors
Connecting Providers
Link Errors
Error delivery
URL Query
Vital performs a 307 Temporary Redirect to the redirect_url specified in your Link Token in the following scenarios:
- All connections via the Vital Link widget
- Connect OAuth Provider endpoint used by your Custom Widget
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:
- Connect Password Provider endpoint used by your Custom Widget
- Connect Email Provider endpoint used by your Custom Widget
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 Type | Description |
|---|---|
invalid_token | The Link Token is invalid or has expired. |
token_not_validated | The OAuth Link process has not been initiated via the Link OAuth Provider endpoint. |
token_consumed | The Link Token has been used to initiate a connection. |
provider_credential_error | OAuth: An error occurred during the provider authentication flow. Password & Email: The supplied user credential is invalid. |
provider_api_error | The credential is valid, but an error occurred on an API call required by Vital to fully establish the connection. |
unsupported_region | The region you specified is not supported. Freestyle Libre only. |
duplicate_connection | The 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_granted | User did not grant all required scopes, so Vital cannot establish the connection. |