Error Reference

Handling authentication errors.

If signup fails at any stage of the process, the user will be redirected back to your application with query parameters error and error_reason. It is left up to each individual application to decide how the failures should be communicated to the user. Currently error and error_reason fields can have multiple values depending on the failure type.
Error Codes:
Type
Reason
Error definitions
application_misconfigured
email_is_required
email parameter is required
application_misconfigured
email_is_not_valid
email is not valid
application_misconfigured
hat_name_is_required
hat_name parameter is required
application_misconfigured
hat_name_is_not_valid
hat_name is not valid
application_misconfigured
application_id_is_required
application_id parameter is required
application_misconfigured
application_id_not_found
application_id is specified but not found in the available application list. If you requested a different language for this application, it might not be available.
application_misconfigured
redirect_uri_is_required
redirect_uri is required to redirect the user back to your application
hat_provisioning
hat_name_already_taken
Inform the user that their username is already taken
hat_provisioning
email_already_taken
Inform the user that their email already exists
hat_provisioning
uncaught_error
Possibly a temporary issue, wait and retry the process
hat_provisioning
unexpected_error
Possibly a temporary issue, wait and retry the process
hat_provisioning
next_step_undefined
Registration is completed but the next step to navigate the user back to the provided URI or to set up dependencies on their own HAT has failed
hat_exception
enabling_application_failed
Possibly a temporary issue, wait and retry the process
hat_exception
hat_authentication_failed
Possibly a temporary issue, wait and retry the process
hat_exception
hat_communication_failure
Possibly a temporary issue, wait and retry the process

Build on Dataswift One - Previous

Advanced Topics

Access Tokens

Last modified 8mo ago

Type	Reason	Error definitions
application_misconfigured	email_is_required	`email` parameter is required
application_misconfigured	email_is_not_valid	`email` is not valid
application_misconfigured	hat_name_is_required	`hat_name` parameter is required
application_misconfigured	hat_name_is_not_valid	`hat_name` is not valid
application_misconfigured	application_id_is_required	`application_id` parameter is required
application_misconfigured	application_id_not_found	`application_id` is specified but not found in the available application list. If you requested a different language for this application, it might not be available.
application_misconfigured	redirect_uri_is_required	`redirect_uri` is required to redirect the user back to your application
hat_provisioning	hat_name_already_taken	Inform the user that their username is already taken
hat_provisioning	email_already_taken	Inform the user that their email already exists
hat_provisioning	uncaught_error	Possibly a temporary issue, wait and retry the process
hat_provisioning	unexpected_error	Possibly a temporary issue, wait and retry the process
hat_provisioning	next_step_undefined	Registration is completed but the next step to navigate the user back to the provided URI or to set up dependencies on their own HAT has failed
hat_exception	enabling_application_failed	Possibly a temporary issue, wait and retry the process
hat_exception	hat_authentication_failed	Possibly a temporary issue, wait and retry the process
hat_exception	hat_communication_failure	Possibly a temporary issue, wait and retry the process