EndpointsScreenings

Get entity screening details

Get the latest screening for an entity. Token scopes: screenings:read

Authentication

AuthorizationBearer
## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

entity_typeenumRequired

The type of entity to screen. Only ‘profile’, ‘hris_profile’, ‘legal_entity’ are accepted.

Allowed values:
entity_idstringRequiredformat: "uuid"
UUID v4 of the entity

Response

Details of the screening request for the specified entity type and ID.
resultenum
The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review.
Allowed values:
entity_idstring
UUID of the entity.
entity_typeenum
The type of entity being screened.
Allowed values:
detailed_resultsobject
Details of checks performed for this screening.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error