Requestors
  • 20 Oct 2021
  • Dark
    Light
  • PDF

Requestors

  • Dark
    Light
  • PDF

Create a Requestor


All reports in the GoodHire API are also associated with a requestor object. The requestor represents the user who will be running background reports. There can be multiple requestors per company corresponding to the multiple user accounts under a single employer.

HTTP Request

POST /Company/:company_id/Requestor

URL Parameters

Parameter Description
company_id The id of the company to associate the requestor with

Customer Paramaters

Name Required Format Descrption
Email x string
Firstname x string
LastName x string
RoleType string The requestor’s report access privilege. See RoleType Values
Phone string
Title string Position title

RoleType Values

  • employerAdmin - Allows a user to make changes to the company information, payment method, add/edit users, view reports or purchase reports.
  • employerBilling - Allows a user to access the Billing section only, which includes add/edit payment methods, view order history, and manage the account’s invoices. This role does not allow the user to place orders for new reports, make changes to the company information, or add/edit other users.
  • employerOrderOnly - Allows a user to make changes only to their profile and place orders for new reports. This role does not allow the user to view reports, make changes to the company information, manage payment methods, or add/edit other users.
  • employerReadAndOrder - Allows a user to make changes only to their profile, view reports they order only, and place orders for new reports. This role does not allow changes to the company information, manage payment methods, or add/edit other users.
  • employerReadOnly - Allows a user to make changes only to their profile and view all reports ordered within the account. This role does not allow the user to place orders for new reports, make changes to the company information, manage payment methods, or add/edit other users.
  • OrganizationReadAndOrder - Allows the same access as 'Read/order reports' role but with access to view all reports ordered within the account.
  • employerPending - Does not grant any access. This allows company administrators to create a user profile prior to making a decision as to which role they want to assign.
  • IntegrationUser - Allows a user to manage the account's API dashboard.
When creating a requestor, If a submitted requestor email address already exists in our system, the requestor id will be flagged as a duplicate. See Duplicate Resources for more information.

Request Example:

curl -i -X POST -H "Authorization: ApiKey YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api-sandbox.goodhire.com/v1/Company/8f9640d4-66ce-4661-8144-24695c902b72/Requestor \
-d '{ 
    "Email": "YOUR_EMAIL",
    "FirstName": "Test",
    "LastName": "Requestor",
    "RoleType": "employerAdmin",
    "Phone": "(415)1112222",
    "Title": "HR Manager"
}'

Response

The API will respond with a HTTP 201 Created and the created requestor.

In addition, the API will send an email to the newly created requestor with a link to GoodHire.com. From this link, the requestor will setup a GoodHire.com site password and provide any missing fields that are needed for the requestor’s company to be verified.

Response Example:

{ 
    "Id": "8f9640d4-66ce-4661-8144-24695c902b72",
    "Email": "YOUR_EMAIL",
    "FirstName": "Test",
    "LastName": "Requestor",
    "Phone": "(415)1112222",
    "Title": "HR Manager",
}

Response Attributes

Name Format Descrption
Email string
Firstname string
LastName string
RoleType string The requestor’s report access privilege. See RoleType Values listed above
Phone string
Title string Position title

Retrieve a Requestor


This endpoint retrieves an existing requestor.

HTTP Request

GET /company/:company_id/requestor/:requestor_id

URL Parameters

Parameter Description
company_id The id of the requestor’s company
requestor_id The id of the requestor to retrieve

Request Example:

curl -H "Authorization: ApiKey YOUR_API_KEY" \
https://api-sandbox.goodhire.com/v1/Company/8f9640d4-66ce-4661-8144-24695c902b72/Requestor/8f9640d4-66ce-4661-8144-24695c902b72

Response

The API will respond with a HTTP 200 Ok and the retrieved requestor.

Response Example:

{ 
    "Id": "8f9640d4-66ce-4661-8144-24695c902b72",
    "Email": "customer@example.com",
    "FirstName": "Test",
    "LastName": "Requestor",
    "Phone": "(415)1112222",
    "Title": "HR Manager",
}

Response Attributes

Name Format Descrption
Email string
Firstname string
LastName string
RoleType string The requestor’s report access privilege. See RoleType Values listed above
Phone string
Title string Position title

Next Steps


Create a report - Reports


Was this article helpful?

What's Next