How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deel subpackage_screenings API

The subpackage_screenings API from Deel — 6 operation(s) for subpackage_screenings.

Deel subpackage_screenings API is one of 91 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 6 operations across 6 paths, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.

6 operations 6 paths 47 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.letsdeel.com/rest/v2
https://api-staging.letsdeel.com/rest/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Deel subpackage_screenings API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (deelToken). It accepts HTTP bearer tokens (oauth2).

  • deelToken — Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…
  • oauth2 — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_screenings 6
POST
/screenings/manual-verification
Create manual verification screening
create-manual-verification 1 param body → 201400401403404409500
POST
/veriff/session
Create Veriff session
create-veriff-session 1 param body → 201400401403404500
GET
/screenings/aml/{entity_type}/{entity_id}
Get entity screening details
get-aml-details 3 params → 200400401403404500
GET
/screenings/verification-method
Get verification method
get-verification-method 3 params → 200400401403404500
GET
/screenings/kyc/details
Get worker's KYC details
get-kyc-details 4 params → 200400401403404409500
POST
/screenings/kyc/external
Submit external KYC
submit-external-kyc 1 param body → 201400401403404500

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData (13 properties), ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData (10 properties), ApiErrorRequest (7 properties), ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest (7 properties). Each schema is shown below with its type and property counts.

ApiErrorRequest
object
7 properties
ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData
object
1 property 1 required
ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData
object
13 properties 9 required
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult
string
The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review.
GetWorkersKycDetailsRequestConflictError
object
1 property
CreateManualVerificationScreeningRequestConflictError
object
2 properties 2 required
ScreeningsAmlEntityTypeEntityIdGetParametersEntityType
string
ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData
object
10 properties 8 required
ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType
string
The type of identity document used for verification
ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults
object
Details of checks performed for this screening.
3 properties
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions
string
The result of the sanctions check.
ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData
object
2 properties 2 required
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep
string
The result of the PEP (Politically Exposed Person) check.
CreateManualVerificationScreeningRequestBadRequestError
object
2 properties 2 required
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType
string
The type of entity being screened.
VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput
object
Input data for the name change KYC operation
3 properties 2 required
VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType
string
The type of KYC operation to perform
GetWorkersKycDetailsRequestForbiddenError
object
1 property
ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus
string
The result of the screening process
ScreeningsVerificationMethodGetParametersDocumentType
string
SubmitExternalKycRequestBadRequestError
object
2 properties
screenings_createManualVerification_Response_201
object
1 property 1 required
screenings_getKYCDetails_Response_200
object
1 property 1 required
screenings_createVeriffSession_Response_201
object
1 property 1 required
ApiError
object
2 properties
ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType
string
Type of KYC document (e.g., passport, driver's license)
screenings_getAMLDetails_Response_200
object
4 properties 4 required
ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
ApiErrorContainer
object
2 properties
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia
string
The result of the adverse media check.
GetWorkersKycDetailsRequestBadRequestError
object
1 property
ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
Screenings_submitExternalKyc_Response_201
object
1 property 1 required
ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus
string
The current KYC verification status of the profile
ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument
object
6 properties 3 required
screenings_getVerificationMethod_Response_200
object
1 property 1 required
AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError
object
1 property
VeriffSessionPostResponsesContentApplicationJsonSchemaData
object
1 property 1 required
VeriffSessionPostRequestBodyContentApplicationJsonSchemaData
object
2 properties 1 required
ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData
object
2 properties 2 required
AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError
object
1 property
ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType
string
Tells your API whether the identity verification check should be performed automatically (“live”) or via human review (“manual”)
ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType
string
The type of KYC operation to perform
ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType
string
The type of document to be verified
GetWorkersKycDetailsRequestNotFoundError
object
1 property
ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-subpackage-screenings-api-openapi.yml Raw ↑

Other APIs Deel publishes across the network.

Deel Default API
Deel subpackage_accounting API
Deel subpackage_adjustments API
Deel subpackage_assets API
Deel subpackage_ats API
Deel subpackage_candidates API
Deel subpackage_consent API
Deel subpackage_contractorAmendments API
Deel subpackage_contractorHiring API
Deel subpackage_contracts API
Deel subpackage_costCalculator API
Deel subpackage_costCenters API
Where this information came from

This is an independent, third-party profile of Deel subpackage_screenings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.