class GdsApi::AccountApi

def match_user_by_email(email:, govuk_account_session: nil)

Returns:
  • (Hash) - One field, "match", indicating whether the session matches the given email address

Parameters:
  • govuk_account_session (String, nil) -- Value of the session header, if not given just checks if the given email address exists.
  • email (String) -- The email address to search for
def match_user_by_email(email:, govuk_account_session: nil)
  querystring = nested_query_string({ email: })
  get_json("#{endpoint}/api/user/match-by-email?#{querystring}", auth_headers(govuk_account_session))
end