Skip to main content
POST
compliance.work-permit.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
destination
string
required

Country code.

Required string length: 1 - 512
nationality
string
required

Country code.

Required string length: 1 - 512
purpose
string

Purpose.

Required string length: 1 - 512

Response

The result

destinationName
string
required

Destination name.

nationalityName
string

Nationality name.

destination
string

Destination.

euBlueCardEligible
boolean

True when eu blue card eligible.

euCitizen
boolean

True when eu citizen.

freeMovement
boolean

True when free movement.

nationality
string

Nationality.

permitType
string

Permit type.

purpose
string

Purpose.

requirementsSummary
string

Requirements summary.

visaRequired
boolean

True when visa required.