After the user receives the password reset email, they will click the link within the email to be sent to the password reset page on your website, which should be located at [your website]/reset-password?[query-parameters]. The query parameters will be id, token, and hash. The user will have to type their email back into a form on your page and submit it. The email address as well as the query parameters need to be sent together using the password recover method below.
| Method | URL |
| POST | https://api.fairwarningsoftware.com/v1.1.1/user/password/recover/[email-address] |
Below are the query parameters that are required to be passed along with the request.
| Field | Type | Required | Description |
| id | int | YES | The [id] query string parameter. |
| token | string | YES | The [token] query string parameter. |
| hash | string | YES | The [hash] query string parameter. |
If successful, the response will contain the user details, or else it will contain an error.
| Status | Response |
| 200 | { "user_id": <user_id>, "user_active": <user_active>, "user_verified": <user_verified>, "user_requires_password_reset": <user_requires_password_reset>, "user_type": <user_type>, "type_id": <type_id>, "user_mailing_lists": <user_mailing_lists>, "user_is_consignor": <user_is_consignor>, "user_is_referrer": <user_is_referrer>, "user_is_account_exec": <user_is_account_exec>, "user_is_preferred_bidder": <user_is_preferred_bidder>, "user_is_tax_exempt": <user_is_tax_exempt>, "user_tax_id": <user_tax_id>, "user_tax_id_expiration_month": <user_tax_id_expiration_month>, "user_tax_id_expiration_year": <user_tax_id_expiration_year>, "user_tax_id_state": <user_tax_id_state>, "user_reg_date": <user_reg_date>, "user_icon": <user_icon>, "user_email": <user_email>, "user_alt_email": <user_alt_email>, "user_prefix": <user_prefix>, "user_fname": <user_fname>, "user_mname": <user_mname>, "user_lname": <user_lname>, "user_phone": <user_phone>, "user_alt_phone": <user_alt_phone>, "user_fax": <user_fax>, "user_company": <user_company> } |
| 401 | {"error":"The API keys provided are invalid."} |
| 403 | {"error":"API keys are missing."} |
| 404 | {"error":"API method ([method]) not found."} |
| 500 | {"error": <custom error>} |
| Status | Response |
| 200 | <?xml version="1.0"?> <response> <user_id>[user_id]</user_id> <user_active>[user_active]</user_active> <user_verified>[user_verified]</user_verified> <user_requires_password_reset>[user_requires_password_reset]</user_requires_password_reset> <user_update_id>[user_update_id]</user_update_id> <user_type>[user_type]</user_type> <type_id>[type_id]</type_id> <user_mailing_lists>[user_mailing_lists]</user_mailing_lists> <user_is_consignor>[user_is_consignor]</user_is_consignor> <user_is_referrer>[user_is_referrer]</user_is_referrer> <user_is_account_exec>[user_is_account_exec]</user_is_account_exec> <user_is_preferred_bidder>[user_is_preferred_bidder]</user_is_preferred_bidder> <user_is_tax_exempt>[user_is_tax_exempt]</user_is_tax_exempt> <user_tax_id>[user_tax_id]</user_tax_id> <user_tax_id_expiration_month>[user_tax_id_expiration_month]</user_tax_id_expiration_month> <user_tax_id_expiration_year>[user_tax_id_expiration_year]</user_tax_id_expiration_year> <user_tax_id_state>[user_tax_id_state]</user_tax_id_state> <user_reg_date>[user_reg_date]</user_reg_date> <user_icon>[user_icon]</user_icon> <user_email>[user_email]</user_email> <user_alt_email>[user_alt_email]</user_alt_email> <user_prefix>[user_prefix]</user_prefix> <user_fname>[user_fname]</user_fname> <user_mname>[user_mname]</user_mname> <user_lname>[user_lname]</user_lname> <user_phone>[user_phone]</user_phone> <user_alt_phone>[user_alt_phone]</user_alt_phone> <user_fax>[user_fax]</user_fax> <user_company>[user_company]</user_company> </response> |
| 401 | <?xml version="1.0"?> <response><error>The API keys provided are invalid</error></response> |
| 403 |
<?xml version="1.0"?> <response><error>API keys are missing.</error></response> |
| 404 |
<?xml version="1.0"?> <response><error>API method ([method]) not found.</error></response> |
| 500 | <?xml version="1.0"?> <response><error>[custom error]</error></response> |
| Field | Type | Description |
| user_id | int | The unique identifier for the user |
| user_active | bool | Whether the user account is active |
| user_verified | bool | Whether the user has verified their email address |
| user_requires_password_resest | bool | Whether the user must reset their password after logging in |
| user_type | int | Signifies whether the user is an admin (1) or not (2) |
| type_id | int | Custom user type associated with this user |
| user_mailing_lists | string | A JSON formatted string with the mailing lists this user is registered for |
| user_is_consignor | bool | Whether the user is a consignor |
| user_is_referrer | bool | Whether the user is a referrer |
| user_is_account_exec | bool | Whether the user is an account executive |
| user_is_preferred_bidder | bool | Whether the user is a preferred bidder |
| user_is_tax_exempt | bool | Whether the user is marked as tax exempt |
| user_tax_id | string | The tax ID for the user |
| user_tax_id_expiration_month | int | The month the tax ID expires |
| user_tax_id_expiration_year | int | The year the tax ID expires |
| user_tax_id_state | string | The state in which the tax ID is registered |
| user_reg_date | datetime | The date and time the user registered their account |
| user_icon | string | The image name for the user icon |
| user_email | string | The user's email address |
| user_alt_email | string | An alternate email address for the user |
| user_prefix | string | The user's name prefix |
| user_fname | string | The user's first name |
| user_mname | string | The user's middle name |
| user_lname | string | The user's last name |
| user_phone | string | The user's phone number |
| user_alt_phone | string | An alternate phone number for the user |
| user_fax | string | The user's fax number |
| user_company | string | The user's company name |