This API returns a collection of legal entities/business units for your organization. Often this resource is used to separate operating entities, particularly when more the organization has more than one Memorandum of Understanding (MOU) and E-Verify account.
Method
GET
Resource Information
| Requires authentication? |
YES |
| Request formats |
JSON |
| Response formats |
JSON |
Parameters
| Parameter |
Required |
Description |
| page |
No |
specifies the page number from where you want to begin accessing records |
Filtering
| Parameter |
Required |
Description |
| page |
No |
specifies the page number from where you want to begin accessing records |
Filtering
The fields in the table below can be used in the query string of a GET request, for example:
GET https://<server>/v1/employees?firstName=John
Currently, it is only possible to query for exact values (no wildcards or partial matches)
| Parameter |
Type |
Description |
| entityName |
string |
Name of the legal entity/business unit as documented in Guardian |
| everifyId |
string |
The numerical ID of the E-Verify account associated to the legal entity/business unit |
| string |
Employer identification number associated to the legal entity |
Example
Request Example: GET https://<server>/v1/eins?page_size=5&page=1
Response Example:
{
""searchResult"": [
{
""everifyEffectiveDate"": null,
""entityName"": ""ABC Corporation"",
""everifyId"": null,
""active"": true,
""everifyStatus"": ""Not Ready"",
""id"": 2020,
""ein"": """"
},
{
""everifyEffectiveDate"": null,
""entityName"": ""Acme Inc"",
""everifyId"": null,
""active"": true,
""everifyStatus"": ""Not Ready"",
""id"": 2021,
""ein"": """"
}
],
""links"": [
{
""href"": ""/v1/eins"",
""rel"": ""self""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""first""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""last""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""next""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""previous""
}
]
}
Single Record Example
Request: GET https://<server>/v1/eins/
Response:
{
""everifyEffectiveDate"": null,
""links"": [
{
""href"": ""/v1/eins/2021"",
""rel"": ""self""
}
],
""entityName"": ""Acme Inc"",
""everifyId"": null,
""active"": true,
""everifyStatus"": ""Not Ready"",
""id"": 2021,
""ein"": """"
}
Single Record Request with Query String Example:
GET https://<server>/v1/eins?entityName=ABC Corporation
Single Record Response Example:
{
""searchResult"": [
{
""everifyEffectiveDate"": null,
""entityName"": ""ABC Corporation"",
""everifyId"": null,
""active"": true,
""everifyStatus"": ""Not Ready"",
""id"": 2020,
""ein"": """"
}
],
""links"": [
{
""href"": ""/v1/eins"",
""rel"": ""self""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""first""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""last""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""next""
},
{
""href"": ""/v1/eins?page=1"",
""rel"": ""previous""
}
]
}