Skip to content

Deel: Immigration schemas

76 Deel schemas with complete fields and constraints.

← Immigration operations · All schemas

Approve a visa application quote — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Approve a visa application quote — 200 response body — data

Referenced models: Approve a visa application quote — 200 response body — data

Approve a visa application quote — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
case_idstringRequired within parentThe unique identifier of the eligibility check case the visa application quote was proposed on.
Format: uuid
created_atstringRequired within parentUTC timestamp when the visa application quote was created.
Format: date-time
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeApproval details of the visa application quote.
description (anyOf 2)nullAlternativeApproval details of the visa application quote.
due_dateJSONRequired within parent
due_date (anyOf 1)stringAlternativeUTC timestamp by which the quoted fees are due once approved.
Format: date-time
due_date (anyOf 2)nullAlternativeUTC timestamp by which the quoted fees are due once approved.
Format: date-time
generated_case_idJSONRequired within parent
generated_case_id (anyOf 1)stringAlternativeThe unique identifier of the visa application case opened when the visa application quote was approved. Null while it is in review.
Format: uuid
generated_case_id (anyOf 2)nullAlternativeThe unique identifier of the visa application case opened when the visa application quote was approved. Null while it is in review.
Format: uuid
idstringRequired within parentThe unique identifier of the visa application quote.
Format: uuid
itemsarrayRequired within parentThe fees that make up the visa application quote.
items[]ModelEach itemExpand Approve a visa application quote — 200 response body — data items item
statusstringRequired within parentIN_REVIEW while the visa application quote waits for the organization to approve it, APPROVED once approved.
Known values: IN_REVIEW, APPROVED
updated_atstringRequired within parentUTC timestamp of the last change to the visa application quote.
Format: date-time

Referenced models: Approve a visa application quote — 200 response body — data items item

Approve a visa application quote — 200 response body — data items item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeAmount of the fee.
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentISO 4217 currency code of the fee.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the quoted fee.
description (anyOf 2)nullAlternativeDescription of the quoted fee.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the quoted fee.
name (anyOf 2)nullAlternativeName of the quoted fee.

Create an immigration case for a contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an immigration case for a contract — 201 response body — data

Referenced models: Create an immigration case for a contract — 201 response body — data

Create an immigration case for a contract — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONRequired within parentThe worker the case is for.
applicant (anyOf 1)ModelAlternativeExpand Create an immigration case for a contract — 201 response body — data applicant The worker the case is for
applicant (anyOf 2)nullAlternative
business_tripJSONRequired within parentThe business trip of a business visa case. Null for other cases.
business_trip (anyOf 1)ModelAlternativeExpand Create an immigration case for a contract — 201 response body — data business trip end date, reason, start date
business_trip (anyOf 2)nullAlternative
case_typeModelRequired within parentExpand Create an immigration case for a contract — 201 response body — data case type
The case type the case was opened with.
citizenshipsarrayRequired within parentISO 3166-1 alpha-2 codes of the worker citizenships known to the case.
citizenships[]stringEach item
closed_atJSONRequired within parent
closed_at (anyOf 1)stringAlternativeUTC timestamp when the case was closed. Null while the case is not closed.
Format: date-time
closed_at (anyOf 2)nullAlternativeUTC timestamp when the case was closed. Null while the case is not closed.
Format: date-time
closureJSONRequired within parentWhy the case was closed. Null while the case is not closed.
closure (anyOf 1)ModelAlternativeExpand Create an immigration case for a contract — 201 response body — data closure note, reason
closure (anyOf 2)nullAlternative
contract_idJSONRequired within parent
contract_id (anyOf 1)stringAlternativeThe contract the case was opened for.
contract_id (anyOf 2)nullAlternativeThe contract the case was opened for.
contract_typeJSONRequired within parent
contract_type (anyOf 1)stringAlternativeType of contract behind the case, for example EOR, COR, CONTRACTOR, DIRECT_EMPLOYEE, PWAC. New values may be added.
contract_type (anyOf 2)nullAlternativeType of contract behind the case, for example EOR, COR, CONTRACTOR, DIRECT_EMPLOYEE, PWAC. New values may be added.
converted_to_case_idJSONRequired within parent
converted_to_case_id (anyOf 1)stringAlternativeThe case this case was converted into, when it was.
converted_to_case_id (anyOf 2)nullAlternativeThe case this case was converted into, when it was.
country_codestringRequired within parentISO 3166-1 alpha-2 code of the destination country.
created_atstringRequired within parentUTC timestamp when the case was created.
Format: date-time
estimated_completion_dateJSONRequired within parent
estimated_completion_date (anyOf 1)stringAlternativeDate the case is expected to be completed.
Format: date
estimated_completion_date (anyOf 2)nullAlternativeDate the case is expected to be completed.
Format: date
filing_typeJSONRequired within parentWhether the case is an initial filing, a renewal or another filing.
filing_type (anyOf 1)stringAlternativeWhether the case is an initial filing, a renewal or another filing.
Known values: INITIAL, RENEWAL, CHANGE_OF_EMPLOYER, REFILING
filing_type (anyOf 2)nullAlternative
full_statusstringRequired within parentStatus of the case including how a closed case ended.
Known values: OPEN, ON_HOLD, CLOSED_POSITIVELY, CLOSED_NEGATIVELY, CLOSED_NEUTRALLY
idstringRequired within parentThe unique identifier of the case.
Format: uuid
is_onboardingbooleanRequired within parentWhether the case is part of the worker onboarding.
parent_case_idJSONRequired within parent
parent_case_id (anyOf 1)stringAlternativeThe case of the main applicant when this is a dependent case.
parent_case_id (anyOf 2)nullAlternativeThe case of the main applicant when this is a dependent case.
reference_idJSONRequired within parent
reference_id (anyOf 1)stringAlternativeHuman-readable reference of the case. Null for cases opened before references existed.
reference_id (anyOf 2)nullAlternativeHuman-readable reference of the case. Null for cases opened before references existed.
sponsoring_entity_idJSONRequired within parent
sponsoring_entity_id (anyOf 1)stringAlternativeLegal entity sponsoring the visa when the client sponsors it.
sponsoring_entity_id (anyOf 2)nullAlternativeLegal entity sponsoring the visa when the client sponsors it.
sponsorshipJSONRequired within parentWho sponsors the visa. Null when unknown or not applicable.
sponsorship (anyOf 1)stringAlternativeWho sponsors the visa. Null when unknown or not applicable.
Known values: DEEL, CLIENT, NO_SPONSORSHIP
sponsorship (anyOf 2)nullAlternative
statusstringRequired within parentCurrent status of the case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringRequired within parentUTC timestamp when the case was last updated.
Format: date-time
visa_categoryJSONRequired within parentVisa category of the case. Null when the case is not about a visa.
visa_category (anyOf 1)stringAlternativeVisa category of the case. Null when the case is not about a visa.
Known values: BUSINESS_VISA, WORK_PERMIT_VISA
visa_category (anyOf 2)nullAlternative
visa_management_feeJSONRequired within parentThe monthly visa management fee that applies to the case after it is completed. Null when no fee applies to the case or it could not be determined.
visa_management_fee (anyOf 1)ModelAlternativeExpand Create an immigration case for a contract — 201 response body — data / visa_management_fee / fee_type: FULL IMMIGRATION MANAGEMENT FEE
visa_management_fee (anyOf 2)nullAlternative
visa_typeJSONRequired within parentThe visa type of the case. Null while none is chosen.
visa_type (anyOf 1)ModelAlternativeExpand Create an immigration case for a contract — 201 response body — data visa type id, name
visa_type (anyOf 2)nullAlternative
work_typestringRequired within parentThe kind of immigration work the case covers.

Referenced models: Create an immigration case for a contract — 201 response body — data case type, Create an immigration case for a contract — 201 response body — data visa type id, name, Create an immigration case for a contract — 201 response body — data applicant The worker the case is for, Create an immigration case for a contract — 201 response body — data business trip end date, reason, start date, Create an immigration case for a contract — 201 response body — data closure note, reason, Create an immigration case for a contract — 201 response body — data / visa_management_fee / fee_type: FULL IMMIGRATION MANAGEMENT FEE

Create an immigration case for a contract — 201 response body — data / visa_management_fee / fee_type: FULL IMMIGRATION MANAGEMENT FEE

FieldTypePresenceDescription and constraints
$objectRootThe monthly visa management fee that applies to the case after it is completed. Null when no fee applies to the case or it could not be determined.
fee_typestringRequired within parentThe kind of visa management fee.
Known values: FULL_IMMIGRATION_MANAGEMENT_FEE
projected_amountJSONRequired within parent
projected_amount (anyOf 1)JSONAlternative
projected_amount (anyOf 1) (anyOf 1)numberAlternativeThe projected monthly fee in USD from the organization pricing. Null when the case does not carry a monthly fee or the organization has no pricing for it.
Format: double
projected_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
projected_amount (anyOf 2)nullAlternativeThe projected monthly fee in USD from the organization pricing. Null when the case does not carry a monthly fee or the organization has no pricing for it.
Format: double

Create an immigration case for a contract — 201 response body — data applicant The worker the case is for

FieldTypePresenceDescription and constraints
$objectRootThe worker the case is for.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeFull name of the worker.
name (anyOf 2)nullAlternativeFull name of the worker.
worker_idstringRequired within parentThe unique identifier of the worker.

Create an immigration case for a contract — 201 response body — data business trip end date, reason, start date

FieldTypePresenceDescription and constraints
$objectRootThe business trip of a business visa case. Null for other cases.
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeLast day of the trip.
Format: date
end_date (anyOf 2)nullAlternativeLast day of the trip.
Format: date
reasonJSONRequired within parent
reason (anyOf 1)stringAlternativeWhy the worker travels.
reason (anyOf 2)nullAlternativeWhy the worker travels.
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeFirst day of the trip.
Format: date
start_date (anyOf 2)nullAlternativeFirst day of the trip.
Format: date

Create an immigration case for a contract — 201 response body — data case type

FieldTypePresenceDescription and constraints
$objectRootThe case type the case was opened with.
idstringRequired within parentThe unique identifier.
namestringRequired within parentThe display name.

Create an immigration case for a contract — 201 response body — data closure note, reason

FieldTypePresenceDescription and constraints
$objectRootWhy the case was closed. Null while the case is not closed.
noteJSONRequired within parent
note (anyOf 1)stringAlternativeAdditional details about the closure.
note (anyOf 2)nullAlternativeAdditional details about the closure.
reasonJSONRequired within parent
reason (anyOf 1)stringAlternativeReason the case was closed or rejected.
reason (anyOf 2)nullAlternativeReason the case was closed or rejected.

Create an immigration case for a contract — 201 response body — data visa type id, name

FieldTypePresenceDescription and constraints
$objectRootThe visa type of the case. Null while none is chosen.
idstringRequired within parentThe unique identifier.
namestringRequired within parentThe display name.

Create an immigration case for a contract — request body — body / data / visa_category: BUSINESS VISA, WORK PERMIT VISA, work type: ELIGIBILITY CHECK business trip

FieldTypePresenceDescription and constraints
$objectRootThe trip to check. Required for BUSINESS_VISA, not allowed otherwise.
end_datestringRequired within parentLast day of the trip, not before start_date.
Format: date
reasonstringRequired within parentWhy the worker travels.
Maximum length: 250
Minimum length: 1
start_datestringRequired within parentFirst day of the trip, today or later.
Format: date

Create an immigration case for a contract — request body — body data

FieldTypePresenceDescription and constraints
$JSONRootThe case to open, chosen by work_type.
discriminator: {"propertyName": "work_type"}
$ (oneOf 1)objectAlternativeOpens an eligibility check for a work permit or a business visa.
$ (oneOf 1).business_tripModelOptionalExpand Create an immigration case for a contract — request body — body / data / visa_category: BUSINESS VISA, WORK PERMIT VISA, work type: ELIGIBILITY CHECK business trip
The trip to check. Required for BUSINESS_VISA, not allowed otherwise.
$ (oneOf 1).contract_idstringRequired within parentThe contract of the worker the case is for.
Maximum length: 50
Pattern: ^[A-Za-z0-9_-]+$
$ (oneOf 1).countrystringRequired within parentISO 3166-1 alpha-2 code of the destination country.
Maximum length: 2
$ (oneOf 1).visa_categorystringRequired within parentThe visa category to check eligibility for.
One of: BUSINESS_VISA, WORK_PERMIT_VISA
$ (oneOf 1).work_typestringRequired within parentDiscriminator value: ELIGIBILITY_CHECK
One of: ELIGIBILITY_CHECK
$ (oneOf 2)objectAlternativeOpens a right to work check with the worker's nationality from the contract.
$ (oneOf 2).contract_idstringRequired within parentThe contract of the worker the case is for.
Maximum length: 50
Pattern: ^[A-Za-z0-9_-]+$
$ (oneOf 2).countrystringRequired within parentISO 3166-1 alpha-2 code of the destination country.
Maximum length: 2
$ (oneOf 2).work_typestringRequired within parentDiscriminator value: RIGHT_TO_WORK
One of: RIGHT_TO_WORK

Referenced models: Create an immigration case for a contract — request body — body / data / visa_category: BUSINESS VISA, WORK PERMIT VISA, work type: ELIGIBILITY CHECK business trip

Create an immigration case — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an immigration case — 201 response body — data
The immigration case data returned after successful creation

Referenced models: Create an immigration case — 201 response body — data

Create an immigration case — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe immigration case data returned after successful creation
closure_noteJSONOptional
closure_note (anyOf 1)stringAlternativeOptional note explaining why the case was closed
Maximum length: 400
closure_note (anyOf 2)nullAlternativeOptional note explaining why the case was closed
Maximum length: 400
closure_reasonJSONOptional
closure_reason (anyOf 1)stringAlternativeStandardized reason for case closure
closure_reason (anyOf 2)nullAlternativeStandardized reason for case closure
created_atstringRequired within parentTimestamp when the case was created
Format: date-time
idstringRequired within parentUnique identifier for the case
Format: uuid
processModelRequired within parentExpand Create an immigration case — 201 response body — data process
Details about the current immigration process associated with the case
statusstringRequired within parentCurrent status of the case
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringRequired within parentTimestamp when the case was last updated
Format: date-time

Referenced models: Create an immigration case — 201 response body — data process

Create an immigration case — 201 response body — data process

FieldTypePresenceDescription and constraints
$objectRootDetails about the current immigration process associated with the case
idstringRequired within parentUnique identifier for the process
Format: uuid
process_namestringRequired within parentName of the immigration process
status_namestringRequired within parentHuman-readable status of the process

Create an immigration case — request body — body / data / case_type: BUSINESS VISA

FieldTypePresenceDescription and constraints
$objectRoot
case_typestringRequired within parentThe type of immigration case to be created. Determines the workflow and requirements
One of: BUSINESS_VISA
contract_idstringOptionalThe contract object identifier. If not provided, team_id is required and employee_details must include first_name, last_name, and email.
Maximum length: 20
country_codestringRequired within parentISO 3166-1 alpha-2 country code where the immigration case needs to be processed
Maximum length: 2
employee_detailsModelRequired within parentExpand Create an immigration case — request body — body / data / case_type: BUSINESS VISA employee details
Employee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contract_id is present.
entity_idstringOptionalThe unique identifier of the entity sponsoring the visa. Required for sponsored visa applications
Format: uuid
team_idstringOptionalThe id of the team for which the employee will be added to. Required if contract_id is not provided
Format: uuid
travel_informationModelRequired within parentExpand Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information
Travel details for the business visa
visa_type_idstringRequired within parentThe id of visa type that is being applied for. Identifies the type of the visa
Format: uuid

Referenced models: Create an immigration case — request body — body / data / case_type: BUSINESS VISA employee details, Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information

Create an immigration case — request body — body / data / case_type: BUSINESS VISA employee details

FieldTypePresenceDescription and constraints
$objectRootEmployee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contract_id is present.
citizenshipsarrayRequired within parentList of ISO 3166-1 alpha-2 country codes representing employee's citizenships
citizenships[]stringEach itemMaximum length: 2
Minimum length: 2
emailstringOptionalEmployee's email address. Required if contract_id is not provided
Format: email
Maximum length: 255
Minimum length: 3
first_namestringOptionalEmployee's first name. Required if contract_id is not provided
Maximum length: 100
Minimum length: 3
last_namestringOptionalEmployee's last name. Required if contract_id is not provided
Maximum length: 100
Minimum length: 3
residencestringRequired within parentISO 3166-1 alpha-2 country code of employee's current residence
Maximum length: 2
Minimum length: 2

Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information

FieldTypePresenceDescription and constraints
$objectRootTravel details for the business visa
end_datestringRequired within parentTrip end date in YYYY-MM-DD format
Format: date
purposeModelRequired within parentExpand Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information purpose
The purpose of the business trip
start_datestringRequired within parentTrip start date in YYYY-MM-DD format
Format: date

Referenced models: Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information purpose

Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information purpose

FieldTypePresenceDescription and constraints
$stringRootThe purpose of the business trip
One of: INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT, INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT, MEETINGS_WITH_OR_FOR_A_CLIENT, EXT_BUS_MEET_NO_WORK, EXT_BUS_DELIVER_SERVICE, EXT_BUS_MEET_PROSPECT_INFO, EXT_BUS_MEET_PROSPECT_SALES, NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS, CONFERENCE, TEAM_OFFSITE, SPEAKING_AT_CONFERENCE_UNPAID, SPEAKING_AT_CONFERENCE_PAID, CONF_WORKSHOP_PAID, CONF_ATTEND_FAIR_VISITOR, CONF_EXHIBIT_FAIR, ATTENDING_INTERNAL_TRAINING, ATTENDING_EXTERNAL_TRAINING, DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID, DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID, TRAIN_ACADEMIC_OBSERV, RESEARCH_DELIVER_EXT, ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION, TECH_SUPERVISION, TECH_SUPPORT_HANDS_ON, TECH_INTERNAL_TESTING, DRIVR_TEST_DEMO_IN_COUNTRY, DRIVR_TEST_DEMO_OUT_OF_COUNTRY, OFFSHORE_TERRITORIAL, OFFSHORE_INTL_WATERS, MARITIME_CREW, OTHER_SEASONAL_LABOUR, MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES, MEETINGS_WITH_POTENTIAL_CLIENTS, OTHER_EXTERNAL_BUSINESS, DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS, PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES, TECHNICAL_SUPPORT_OR_SUPERVISION, OTHER_HANDS_ON_LABOUR, OTHER

Create an immigration case — request body — body / data / case_type: EOR VISA

FieldTypePresenceDescription and constraints
$objectRoot
case_typestringRequired within parentThe type of immigration case to be created. Determines the workflow and requirements
One of: EOR_VISA
contract_idstringRequired within parentThe contract object identifier. Required for document reviews and visa applications
Maximum length: 20
country_codestringRequired within parentISO 3166-1 alpha-2 country code where the immigration case needs to be processed
Maximum length: 2
visa_type_idstringOptionalThe id of visa type that is being applied for. Identifies the type of the visa.
Format: uuid

Create an immigration case — request body — body / data / case_type: PRE HIRE EOR VISA

FieldTypePresenceDescription and constraints
$objectRoot
case_typestringRequired within parentThe type of immigration case to be created. Determines the workflow and requirements
One of: PRE_HIRE_EOR_VISA
country_codestringRequired within parentISO 3166-1 alpha-2 country code where the immigration case needs to be processed
Maximum length: 2
team_idstringRequired within parentThe unique identifier of the team for which the pre-hire visa case is being created
Format: uuid
visa_type_idstringOptionalThe id of visa type that is being applied for. Identifies the type of the visa.
Format: uuid

Create an immigration case — request body — body / data / case_type: PRE HIRE SPONSORSHIP VISA

FieldTypePresenceDescription and constraints
$objectRoot
case_typestringRequired within parentThe type of immigration case to be created. Determines the workflow and requirements
One of: PRE_HIRE_SPONSORSHIP_VISA
country_codestringRequired within parentISO 3166-1 alpha-2 country code where the immigration case needs to be processed
Maximum length: 2
entity_idstringOptionalThe unique identifier of the entity sponsoring the visa. Required for sponsored visa applications
Format: uuid
team_idstringRequired within parentThe unique identifier of the team for which the pre-hire sponsorship visa case is being created
Format: uuid
visa_type_idstringOptionalThe id of visa type that is being applied for. Identifies the type of the visa.
Format: uuid

Create an immigration case — request body — body / data / case_type: RIGHT TO WORK

FieldTypePresenceDescription and constraints
$objectRoot
case_typestringRequired within parentThe type of immigration case to be created. Determines the workflow and requirements
One of: RIGHT_TO_WORK
contract_idstringRequired within parentThe contract object identifier. Required for document reviews and visa applications
Maximum length: 20
country_codestringRequired within parentISO 3166-1 alpha-2 country code where the immigration case needs to be processed
Maximum length: 2

Create an immigration case — request body — body / data / case_type: SPONSORED VISA

FieldTypePresenceDescription and constraints
$objectRoot
case_typestringRequired within parentThe type of immigration case to be created. Determines the workflow and requirements
One of: SPONSORED_VISA
contract_idstringRequired within parentThe contract object identifier. Required for document reviews and visa applications
Maximum length: 20
country_codestringRequired within parentISO 3166-1 alpha-2 country code where the immigration case needs to be processed
Maximum length: 2
entity_idstringRequired within parentThe unique identifier of the entity sponsoring the visa. Required for sponsored visa applications
Format: uuid
visa_type_idstringOptionalThe id of visa type that is being applied for. Identifies the type of the visa.
Format: uuid

Create an immigration case — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create an immigration case — request body — body / data / case_type: RIGHT TO WORK
$ (oneOf 2)ModelAlternativeExpand Create an immigration case — request body — body / data / case_type: EOR VISA
$ (oneOf 3)ModelAlternativeExpand Create an immigration case — request body — body / data / case_type: SPONSORED VISA
$ (oneOf 4)ModelAlternativeExpand Create an immigration case — request body — body / data / case_type: PRE HIRE EOR VISA
$ (oneOf 5)ModelAlternativeExpand Create an immigration case — request body — body / data / case_type: PRE HIRE SPONSORSHIP VISA
$ (oneOf 6)ModelAlternativeExpand Create an immigration case — request body — body / data / case_type: BUSINESS VISA

Referenced models: Create an immigration case — request body — body / data / case_type: RIGHT TO WORK, Create an immigration case — request body — body / data / case_type: EOR VISA, Create an immigration case — request body — body / data / case_type: SPONSORED VISA, Create an immigration case — request body — body / data / case_type: PRE HIRE EOR VISA, Create an immigration case — request body — body / data / case_type: PRE HIRE SPONSORSHIP VISA, Create an immigration case — request body — body / data / case_type: BUSINESS VISA

Get business visa eligibility and requirements — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get business visa eligibility and requirements — 200 response body — data

Referenced models: Get business visa eligibility and requirements — 200 response body — data

Get business visa eligibility and requirements — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the visa type
estimated_timelineJSONRequired within parentEstimated processing timeline, in weeks, months or years
estimated_timeline (anyOf 1)stringAlternativeEstimated processing timeline, in weeks, months or years
Known values: SIX_WEEKS, THREE_MONTHS, ONE_WEEK, THREE_WEEKS, ONE_YEAR, TWO_WEEKS, FIVE_WEEKS, TWO_MONTHS, FIVE_MONTHS, FOUR_MONTHS, SIX_MONTHS, FOUR_WEEKS
estimated_timeline (anyOf 2)nullAlternative
feeJSONRequired within parent
fee (anyOf 1)JSONAlternative
fee (anyOf 1) (anyOf 1)numberAlternativeFee amount
Format: double
fee (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fee (anyOf 2)nullAlternativeFee amount
Format: double
fee_currencyJSONRequired within parent
fee_currency (anyOf 1)stringAlternativeCurrency code for the fee in ISO 4217 format
Pattern: ^[A-Z]{3}$
fee_currency (anyOf 2)nullAlternativeCurrency code for the fee in ISO 4217 format
Pattern: ^[A-Z]{3}$
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the visa type
name (anyOf 2)nullAlternativeName of the visa type
qualificationstringRequired within parentVisa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options.
Known values: VISA_REQUIRED, NO_VISA_REQUIRED, UNSUPPORTED
visa_type_idJSONRequired within parent
visa_type_id (anyOf 1)stringAlternativeUnique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint.
Format: uuid
visa_type_id (anyOf 2)nullAlternativeUnique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint.
Format: uuid

Get business visa eligibility and requirements — request body — query trip reason

FieldTypePresenceDescription and constraints
$stringRootOne of: INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT, INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT, MEETINGS_WITH_OR_FOR_A_CLIENT, MEETINGS_WITH_POTENTIAL_CLIENTS, NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS, OTHER_EXTERNAL_BUSINESS, CONFERENCE, TEAM_OFFSITE, SPEAKING_AT_CONFERENCE_UNPAID, SPEAKING_AT_CONFERENCE_PAID, ATTENDING_INTERNAL_TRAINING, ATTENDING_EXTERNAL_TRAINING, DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS, DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID, DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID, PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES, ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION, TECHNICAL_SUPPORT_OR_SUPERVISION, OTHER_HANDS_ON_LABOUR, MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES, OTHER

Get case timeline — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get case timeline — 200 response body — data

Referenced models: Get case timeline — 200 response body — data

Get case timeline — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
ongoing_actionsJSONRequired within parent
ongoing_actions (anyOf 1)integerAlternativeNumber of actions currently waiting on the client or the employee.
ongoing_actions (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processesarrayRequired within parentProcesses of the case in order.
processes[]ModelEach itemExpand Get case timeline — 200 response body — data processes item

Referenced models: Get case timeline — 200 response body — data processes item

Get case timeline — 200 response body — data processes item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the process.
namestringRequired within parentDisplay name of the process.
statestringRequired within parentWhether the process is not started, active or completed.
Known values: ACTIVE, COMPLETED, NOT_STARTED
stepsarrayRequired within parentSteps of the process in order.
steps[]ModelEach itemExpand Get case timeline — 200 response body — data processes item steps item

Referenced models: Get case timeline — 200 response body — data processes item steps item

Get case timeline — 200 response body — data processes item steps item

FieldTypePresenceDescription and constraints
$objectRoot
actionsarrayRequired within parentActions attached to the step, earliest due first.
actions[]ModelEach itemExpand Get case timeline — 200 response body — data processes item steps item actions item
activated_atJSONRequired within parent
activated_at (anyOf 1)stringAlternativeUTC timestamp when the step became active. Null while the step has not started.
Format: date-time
activated_at (anyOf 2)nullAlternativeUTC timestamp when the step became active. Null while the step has not started.
Format: date-time
completed_atJSONRequired within parent
completed_at (anyOf 1)stringAlternativeUTC timestamp when the step was completed. Null while the step is open.
Format: date-time
completed_at (anyOf 2)nullAlternativeUTC timestamp when the step was completed. Null while the step is open.
Format: date-time
idstringRequired within parentThe unique identifier of the step.
namestringRequired within parentDisplay name of the step.
statestringRequired within parentWhether the step is not started, active or completed.
Known values: ACTIVE, COMPLETED, NOT_STARTED

Referenced models: Get case timeline — 200 response body — data processes item steps item actions item

Get case timeline — 200 response body — data processes item steps item actions item

FieldTypePresenceDescription and constraints
$objectRoot
completed_atJSONRequired within parent
completed_at (anyOf 1)stringAlternativeUTC timestamp when the action was completed. Null while the action is open.
Format: date-time
completed_at (anyOf 2)nullAlternativeUTC timestamp when the action was completed. Null while the action is open.
Format: date-time
descriptionstringRequired within parentWhat the assigned party has to do.
due_dateJSONRequired within parent
due_date (anyOf 1)stringAlternativeUTC timestamp by which the action is expected to be completed.
Format: date-time
due_date (anyOf 2)nullAlternativeUTC timestamp by which the action is expected to be completed.
Format: date-time
idJSONRequired within parent
id (anyOf 1)stringAlternativeThe unique identifier of the action.
id (anyOf 2)nullAlternativeThe unique identifier of the action.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeShort title of the action.
name (anyOf 2)nullAlternativeShort title of the action.
statusJSONRequired within parentProgress of the action.
status (anyOf 1)stringAlternativeProgress of the action.
Known values: TODO, ONGOING, COMPLETED, ARCHIVED
status (anyOf 2)nullAlternative
typeModelRequired within parentExpand Get case timeline — 200 response body — data processes item steps item actions item type
The kind of action expected from the assigned party.
user_typestringRequired within parentThe party expected to complete the action: the client organization or the employee.
Known values: CLIENT, APPLICANT

Referenced models: Get case timeline — 200 response body — data processes item steps item actions item type

Get case timeline — 200 response body — data processes item steps item actions item type

FieldTypePresenceDescription and constraints
$stringRootThe kind of action expected from the assigned party.
Known values: FILL_FORM, REVIEW_REOPENED_FORM, DOWNLOAD_BUSINESS_LETTER, AGENT_REVIEW_BUSINESS_LETTER, CLIENT_REVIEW_BUSINESS_LETTER, GENERATE_BUSINESS_VISA_LETTER, AGENT_REVIEW, CLIENT_REVIEW_DOCUMENT, AGENT_STATUS_UPDATE, QUOTE_CREATE, QUOTE_DRAFT, QUOTE_APPROVAL, QUOTE_PAYMENT_REQUEST, QUOTE_REJECTED, QUOTE_APPROVAL_EMPLOYEE, UPLOAD_DOCUMENT, UPLOAD_ADDITIONAL_DOCUMENT, FILL_ADDITIONAL_FORM, AGENT_ADD_SALESFORCE_URL, AGENT_STATUS_UPDATE_SLA_BREACH, FILL_REQUIRED_ROLES, REVIEW_SUBMITTED_FORM, REVIEW_FORM, REVIEW_UPLOADED_DOCUMENT, REVIEW_ZENDESK_COMMENT, SIGNATURE_PENDING, PETITION_AI_REVIEW, AMENDMENT_DETAIL_REVIEW, REVIEW_GOOGLE_DOCUMENT, PAY_INVOICE_ACTION, ESTIMATED_COMPLETION, REVIEW_VENDOR_ASSIGNMENT, UPDATE_VISA_TYPE, CUSTOM_TASK, AGENT_ADD_USCIS_RECEIPT_NUMBER, AGENT_ADD_SHIPPING_NUMBER, IDENTITY_VERIFICATION, IDENTITY_VERIFICATION_VERIFF, IDENTITY_VERIFICATION_REVIEW, SEND_VISA_APPLICATION_QUOTE, REVIEW_VISA_APPLICATION_QUOTE, COMPLIANCE_VERIFF, RTW_VERIFICATION_DOCUMENT_REVIEW, UPLOAD_REQUIRED_DOCUMENT, REVIEW_REQUIRED_DOCUMENT, ADD_BUSINESS_VISA_DETAILS, ADD_UK_SHARECODE, RUN_AI_AGENT, REVIEW_VISA_AUTOMATION_PAYLOAD, PRE_HIRE_DOCUMENT_REVIEW, ACKNOWLEDGE_CONTENT, PETITION_AUTONOMOUS_BUILD, PAY_MILESTONE_INVOICE, AGENT_ADD_RFE_DEADLINE

Get immigration case details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get immigration case details — 200 response body — data

Referenced models: Get immigration case details — 200 response body — data

Get immigration case details — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONOptional
applicant (anyOf 1)ModelAlternativeExpand Get immigration case details — 200 response body — data applicant external id, id
applicant (anyOf 2)nullAlternative
case_created_atstringOptionalCreation date of the immigration case.
Format: date-time
case_typestringOptionalName of the case type
country_codestringOptionalThe country of the immigration case.
documentsarrayOptional
documents[]ModelEach itemExpand Get immigration case details — 200 response body — data documents item
estimated_completion_dateJSONOptional
estimated_completion_date (anyOf 1)stringAlternativeEstimated completion date of the immigration case.
Format: date-time
estimated_completion_date (anyOf 2)nullAlternativeEstimated completion date of the immigration case.
Format: date-time
idstringOptionalUnique identifier of immigration case.
last_update_atstringOptionalLast activity on the immigration case.
Format: date-time
processModelOptionalExpand Get immigration case details — 200 response body — data process
statusstringOptionalStatus of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
visa_typeJSONOptional
visa_type (anyOf 1)stringAlternativeThe type of the the visa.
visa_type (anyOf 2)nullAlternativeThe type of the the visa.

Referenced models: Get immigration case details — 200 response body — data process, Get immigration case details — 200 response body — data applicant external id, id, Get immigration case details — 200 response body — data documents item

Get immigration case details — 200 response body — data applicant external id, id

FieldTypePresenceDescription and constraints
$objectRoot
external_idJSONOptional
external_id (anyOf 1)stringAlternativeExternal identifier of the applicant.
external_id (anyOf 2)nullAlternativeExternal identifier of the applicant.
idstringOptionalUnique identifier of the applicant profile id.

Get immigration case details — 200 response body — data documents item

FieldTypePresenceDescription and constraints
$objectRoot
document_typeJSONOptional
document_type (anyOf 1)stringAlternativeThe type of the document. Represents the visa type for right to work cases.
document_type (anyOf 2)nullAlternativeThe type of the document. Represents the visa type for right to work cases.
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiry date of the document.
Format: date-time
expiration_date (anyOf 2)nullAlternativeExpiry date of the document.
Format: date-time
idstringOptionalUnique identifier of the document.
statusstringOptionalStatus of the document.
Known values: IN_REVIEW, ACTIVE, EXPIRED, EXPIRING, UNKNOWN

Get immigration case details — 200 response body — data process

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier of the current active process.
namestringOptionalName of the current active process.
statusstringOptionalStatus of the current active process.

Get specific immigration case details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get specific immigration case details — 200 response body — data

Referenced models: Get specific immigration case details — 200 response body — data

Get specific immigration case details — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONOptionalThe employee for which this Right to Work case has been created for
applicant (anyOf 1)ModelAlternativeExpand Get specific immigration case details — 200 response body — data applicant external id, id
applicant (anyOf 2)nullAlternative
case_typestringOptionalType of the case.
contractModelOptionalExpand Get specific immigration case details — 200 response body — data contract
The contract associated with the returned immigration case
country_codestringOptionalThe country of the immigration case.
created_atstringOptionalCreation date of the immigration case.
Format: date-time
documentsarrayOptionalA list of documents associated to the immigration case
documents[]ModelEach itemExpand Get specific immigration case details — 200 response body — data documents item
estimated_completion_dateJSONOptional
estimated_completion_date (anyOf 1)stringAlternativeEstimated completion date of the immigration case.
Format: date-time
estimated_completion_date (anyOf 2)nullAlternativeEstimated completion date of the immigration case.
Format: date-time
idstringOptionalUnique identifier of immigration case.
processModelOptionalExpand Get specific immigration case details — 200 response body — data process
The current active process
statusstringOptionalStatus of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringOptionalLast activity on the immigration case.
Format: date-time
visa_typeJSONOptional
visa_type (anyOf 1)stringAlternativeThe type of the visa.
visa_type (anyOf 2)nullAlternativeThe type of the visa.

Referenced models: Get specific immigration case details — 200 response body — data process, Get specific immigration case details — 200 response body — data applicant external id, id, Get specific immigration case details — 200 response body — data contract, Get specific immigration case details — 200 response body — data documents item

Get specific immigration case details — 200 response body — data applicant external id, id

FieldTypePresenceDescription and constraints
$objectRootThe employee for which this Right to Work case has been created for
external_idJSONOptional
external_id (anyOf 1)stringAlternativeExternal identifier of the applicant (from partner system or third party).
external_id (anyOf 2)nullAlternativeExternal identifier of the applicant (from partner system or third party).
idstringOptionalUnique identifier of the applicant profile id.

Get specific immigration case details — 200 response body — data contract

FieldTypePresenceDescription and constraints
$objectRootThe contract associated with the returned immigration case
idJSONOptional
id (anyOf 1)stringAlternativeId of the contract associated with the immigration case
id (anyOf 2)nullAlternativeId of the contract associated with the immigration case

Get specific immigration case details — 200 response body — data documents item

FieldTypePresenceDescription and constraints
$objectRoot
document_typeJSONOptional
document_type (anyOf 1)stringAlternativeThe type of the document. Represents the visa type for right to work cases.
document_type (anyOf 2)nullAlternativeThe type of the document. Represents the visa type for right to work cases.
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiry date of the document. If document does not expire, it will be null
Format: date-time
expiration_date (anyOf 2)nullAlternativeExpiry date of the document. If document does not expire, it will be null
Format: date-time
idstringOptionalUnique identifier of the document.
statusstringOptionalStatus of the document.
Known values: IN_REVIEW, ACTIVE, EXPIRED, EXPIRING, PENDING, REJECTED, COMPLETED, FAILED, PROCESSING, UNKNOWN

Get specific immigration case details — 200 response body — data process

FieldTypePresenceDescription and constraints
$objectRootThe current active process
idstringOptionalUnique identifier of the current active process.
namestringOptionalName of the current active process.
rejection_notestringOptionalA detailed description of why the case was rejected. Only available if the case status is REJECTED.
rejection_reasonstringOptionalThe reason why the case was rejected. Only available if the case status is REJECTED.
statusstringOptionalStatus of the current active process.

Immigration document — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Immigration document — 200 response body — data

Referenced models: Immigration document — 200 response body — data

Immigration document — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
document_typeJSONOptional
document_type (anyOf 1)stringAlternativeThe type of the document. Represents the visa type for right to work cases.
document_type (anyOf 2)nullAlternativeThe type of the document. Represents the visa type for right to work cases.
download_linkarrayOptionalS3 download link of all the files uploaded within current document record.
download_link[]stringEach item
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiry date of the document.
Format: date-time
expiration_date (anyOf 2)nullAlternativeExpiry date of the document.
Format: date-time
idstringOptionalThe UUID of document entity.
statusJSONOptionalCurrent status of the document.
status (anyOf 1)stringAlternativeCurrent status of the document.
Known values: IN_REVIEW, APPROVED, REJECTED
status (anyOf 2)nullAlternative

Immigration visa types — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Immigration visa types — 200 response body — data item

Referenced models: Immigration visa types — 200 response body — data item

Immigration visa types — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier of a visa type.
namestringOptionalThe name of a visa.

List case invoices — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List case invoices — 200 response body — data item
has_morebooleanRequired within parentWhether more items are available beyond this page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to pass as cursor to fetch the next page. Null when there is no next page.
next_cursor (anyOf 2)nullAlternativeCursor to pass as cursor to fetch the next page. Null when there is no next page.
total_countJSONRequired within parent
total_count (anyOf 1)JSONAlternative
total_count (anyOf 1) (anyOf 1)integerAlternativeTotal number of invoices issued to the organization for the case.
total_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_count (anyOf 2)nullAlternativeTotal number of invoices issued to the organization for the case.

Referenced models: List case invoices — 200 response body — data item

List case invoices — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeInvoiced amount in the invoice currency.
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentISO 4217 currency code of the invoiced amount.
due_datestringRequired within parentUTC timestamp by which the invoice is due.
Format: date-time
idstringRequired within parentThe public identifier of the invoice, as shown in the Deel platform.
is_paidbooleanRequired within parentWhether the invoice has been settled.
issued_atstringRequired within parentUTC timestamp when the invoice was issued.
Format: date-time
paid_atJSONRequired within parent
paid_at (anyOf 1)stringAlternativeUTC timestamp when the invoice was paid. Null while unpaid.
Format: date-time
paid_at (anyOf 2)nullAlternativeUTC timestamp when the invoice was paid. Null while unpaid.
Format: date-time
quote_idstringRequired within parentThe unique identifier of the quote the invoice was issued for.
Format: uuid
statusstringRequired within parentPayment status of the invoice.
Known values: PENDING, PROCESSING, PREPROCESSING, PAID, CANCELLED, OPEN, AWAITING_PAYMENT, FAILED, SKIPPED, UNPAYABLE, REFUNDED, PROCESSED, CREDITED

List case notes — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List case notes — 200 response body — data item
has_morebooleanRequired within parentWhether more notes are available beyond this page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to pass as cursor to fetch the next page. Null when there is no next page.
next_cursor (anyOf 2)nullAlternativeCursor to pass as cursor to fetch the next page. Null when there is no next page.
total_countJSONRequired within parent
total_count (anyOf 1)JSONAlternative
total_count (anyOf 1) (anyOf 1)integerAlternativeTotal number of externally-visible notes for the case, when available.
total_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_count (anyOf 2)nullAlternativeTotal number of externally-visible notes for the case, when available.

Referenced models: List case notes — 200 response body — data item

List case notes — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentUTC timestamp when the note was created.
Format: date-time
idstringRequired within parentThe unique identifier of the note.
messagestringRequired within parentNote content.
note_typestringRequired within parentThe type of note. Only externally-visible note types are returned by this endpoint.
Known values: EXTERNAL, USCIS_STATUS_UPDATE

List case visa application quotes — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Approve a visa application quote — 200 response body — data

Referenced models: Approve a visa application quote — 200 response body — data

List of immigration cases for workers — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of cases in the current page.
data[]ModelEach itemExpand List of immigration cases for workers — 200 response body — data item
has_morebooleanRequired within parentIndicates whether more results are available for pagination.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeCursor value to be used for fetching the next page of results.
next_cursor (anyOf 2)nullAlternativeCursor value to be used for fetching the next page of results.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of cases matching the search criteria.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List of immigration cases for workers — 200 response body — data item

List of immigration cases for workers — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONRequired within parentApplicant associated with the immigration case.
applicant (anyOf 1)ModelAlternativeExpand List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case
applicant (anyOf 2)nullAlternative
case_typeModelRequired within parentExpand List of immigration cases — 200 response body — data item case type
Type of immigration case.
closureJSONRequired within parentClosure details of the case if the case has been closed.
closure (anyOf 1)ModelAlternativeExpand List of immigration cases for workers — 200 response body — data item closure note, reason
closure (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp indicating when the case was created.
Format: date-time
idstringRequired within parentUnique identifier of the immigration case.
Format: uuid
processModelRequired within parentExpand List of immigration cases — 200 response body — data item process
Current active process associated with the case.
statusstringRequired within parentCurrent lifecycle status of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringRequired within parentTimestamp indicating when the case was last updated.
Format: date-time

Referenced models: List of immigration cases — 200 response body — data item case type, List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case, List of immigration cases — 200 response body — data item process, List of immigration cases for workers — 200 response body — data item closure note, reason

List of immigration cases for workers — 200 response body — data item closure note, reason

FieldTypePresenceDescription and constraints
$objectRootClosure details of the case if the case has been closed.
noteJSONRequired within parent
note (anyOf 1)stringAlternativeAdditional notes explaining the case closure.
Maximum length: 400
note (anyOf 2)nullAlternativeAdditional notes explaining the case closure.
Maximum length: 400
reasonJSONRequired within parentReason why the immigration case was closed.
reason (anyOf 1)stringAlternativeReason why the immigration case was closed.
Known values: CONTRACT_CANCELLED, NATIONALITY_CHANGE, NEW_CASE_TYPE_IS_REQUIRED, ONBOARDING_RELEASED, OTHER
reason (anyOf 2)nullAlternative

List of immigration cases — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of cases in the current page.
data[]ModelEach itemExpand List of immigration cases — 200 response body — data item
has_morebooleanRequired within parentIndicates whether more results are available for pagination.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeCursor value to be used for fetching the next page of results.
next_cursor (anyOf 2)nullAlternativeCursor value to be used for fetching the next page of results.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of cases matching the search criteria.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List of immigration cases — 200 response body — data item

List of immigration cases — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONRequired within parentApplicant associated with the immigration case.
applicant (anyOf 1)ModelAlternativeExpand List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case
applicant (anyOf 2)nullAlternative
case_typeModelRequired within parentExpand List of immigration cases — 200 response body — data item case type
Type of immigration case.
closureJSONRequired within parentClosure details of the case if the case has been closed.
closure (anyOf 1)ModelAlternativeExpand List of immigration cases — 200 response body — data item closure note, reason
closure (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp indicating when the case was created.
Format: date-time
idstringRequired within parentUnique identifier of the immigration case.
Format: uuid
processModelRequired within parentExpand List of immigration cases — 200 response body — data item process
Current active process associated with the case.
statusstringRequired within parentCurrent lifecycle status of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringRequired within parentTimestamp indicating when the case was last updated.
Format: date-time

Referenced models: List of immigration cases — 200 response body — data item case type, List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case, List of immigration cases — 200 response body — data item closure note, reason, List of immigration cases — 200 response body — data item process

List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case

FieldTypePresenceDescription and constraints
$objectRootApplicant associated with the immigration case.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the applicant.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of the applicant.
Format: uuid
namestringRequired within parentFull name of the applicant.
Maximum length: 255

List of immigration cases — 200 response body — data item case type

FieldTypePresenceDescription and constraints
$objectRootType of immigration case.
idstringRequired within parentUnique identifier of the case type.
Format: uuid
namestringRequired within parentHuman-readable name of the case type.
Maximum length: 255

List of immigration cases — 200 response body — data item closure note, reason

FieldTypePresenceDescription and constraints
$objectRootClosure details of the case if the case has been closed.
noteJSONRequired within parent
note (anyOf 1)stringAlternativeAdditional notes explaining the case closure.
Maximum length: 400
note (anyOf 2)nullAlternativeAdditional notes explaining the case closure.
Maximum length: 400
reasonJSONRequired within parentReason why the immigration case was closed.
reason (anyOf 1)stringAlternativeReason why the immigration case was closed.
Known values: CONTRACT_CANCELLED, NATIONALITY_CHANGE, NEW_CASE_TYPE_IS_REQUIRED, ONBOARDING_RELEASED, TERMINATION_REVERSED, CONVERTED_TO_VISA_APPLICATION, OTHER
reason (anyOf 2)nullAlternative

List of immigration cases — 200 response body — data item process

FieldTypePresenceDescription and constraints
$objectRootCurrent active process associated with the case.
idstringRequired within parentUnique identifier of the current process.
Format: uuid
namestringRequired within parentHuman-readable name of the current process step.
Maximum length: 255
statusModelRequired within parentExpand List of immigration cases — 200 response body — data item process status
Current status of the process.

Referenced models: List of immigration cases — 200 response body — data item process status

List of immigration cases — 200 response body — data item process status

FieldTypePresenceDescription and constraints
$objectRootCurrent status of the process.
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of the process status.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of the process status.
Format: uuid
nameJSONRequired within parent
name (anyOf 1)stringAlternativeHuman-readable name of the process status.
Maximum length: 255
name (anyOf 2)nullAlternativeHuman-readable name of the process status.
Maximum length: 255

List of immigration cases — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
searchstringOptionalMaximum length: 100
Minimum length: 3
case_type_idsarrayOptional
case_type_ids[]stringEach itemFormat: uuid
statusesarrayOptional
statuses[]stringEach itemOne of: OPEN, ON_HOLD, CLOSED
countriesarrayOptional
countries[]stringEach itemMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
cursorstringOptional
limitintegerOptionalDefault: 20
Maximum: 100

Retrieve a required document for a case — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve a required document for a case — 200 response body — data

Referenced models: Retrieve a required document for a case — 200 response body — data

Retrieve a required document for a case — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation date of the document request.
Format: date-time
descriptionstringOptionalA short text description of the document requirement to be uploaded.
documentModelOptionalExpand Retrieve a required document for a case — 200 response body — data document
idstringOptionalThe unique identifier of the document requirement.
immigration_document_requirement_idstringOptionalThe unique identifier of the immigration document requirement.
namestringOptionalThe name of the document requirement to be uploaded.
previous_rejected_documentModelOptionalExpand Retrieve a required document for a case — 200 response body — data previous rejected document
updated_atstringOptionalLast update date of the document request.
Format: date-time

Referenced models: Retrieve a required document for a case — 200 response body — data document, Retrieve a required document for a case — 200 response body — data previous rejected document

Retrieve a required document for a case — 200 response body — data document

FieldTypePresenceDescription and constraints
$objectRoot
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiration date of the document. If document does not expire, it will be null
Format: date-time
expiration_date (anyOf 2)nullAlternativeExpiration date of the document. If document does not expire, it will be null
Format: date-time
idstringOptionalUnique identifier of the document.
namestringOptionalThe name of the document.
statusstringOptionalStatus of the document.
Known values: PENDING, IN_REVIEW, ACTIVE, EXPIRING, EXPIRED

Retrieve a required document for a case — 200 response body — data previous rejected document

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier of the document.
rejection_noteJSONOptional
rejection_note (anyOf 1)stringAlternativeA detailed description about why the document was rejected.
rejection_note (anyOf 2)nullAlternativeA detailed description about why the document was rejected.
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeThe reason why the document was rejected.
rejection_reason (anyOf 2)nullAlternativeThe reason why the document was rejected.
statusstringOptionalStatus of the document.
Known values: REJECTED

Retrieve the legacy onboarding right-to-work case for a worker — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data

Referenced models: Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data

Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONOptionalThe employee for which this Right to Work case has been created for
applicant (anyOf 1)ModelAlternativeExpand Get specific immigration case details — 200 response body — data applicant external id, id
applicant (anyOf 2)nullAlternative
case_typestringOptionalType of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.
Known values: IMMIGRATION_DOCUMENT_REVIEW
contractModelOptionalExpand Get specific immigration case details — 200 response body — data contract
The contract associated with the returned immigration case
country_codestringOptionalThe country of the immigration case.
created_atstringOptionalCreation date of the immigration case.
Format: date-time
documentsarrayOptionalA list of documents associated to the immigration case
documents[]ModelEach itemExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item
estimated_completion_dateJSONOptional
estimated_completion_date (anyOf 1)stringAlternativeEstimated completion date of the immigration case.
Format: date-time
estimated_completion_date (anyOf 2)nullAlternativeEstimated completion date of the immigration case.
Format: date-time
idstringOptionalUnique identifier of immigration case.
processModelOptionalExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process
The current active process
statusstringOptionalStatus of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringOptionalLast activity on the immigration case.
Format: date-time
visa_typeJSONOptional
visa_type (anyOf 1)stringAlternativeThe type of the visa.
visa_type (anyOf 2)nullAlternativeThe type of the visa.

Referenced models: Get specific immigration case details — 200 response body — data applicant external id, id, Get specific immigration case details — 200 response body — data contract, Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item, Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process

Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item

FieldTypePresenceDescription and constraints
$objectRoot
document_typeJSONOptional
document_type (anyOf 1)stringAlternativeThe type of the document. Represents the visa type for right to work cases.
document_type (anyOf 2)nullAlternativeThe type of the document. Represents the visa type for right to work cases.
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiry date of the document. If document does not expire, it will be null
Format: date-time
expiration_date (anyOf 2)nullAlternativeExpiry date of the document. If document does not expire, it will be null
Format: date-time
idstringOptionalUnique identifier of the document.
statusstringOptionalStatus of the document.
Known values: IN_REVIEW, ACTIVE, EXPIRED, EXPIRING

Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process

FieldTypePresenceDescription and constraints
$objectRootThe current active process
idstringOptionalUnique identifier of the current active process.
namestringOptionalName of the current active process.
Known values: WORK_AUTHORIZATION_VERIFICATION
rejection_notestringOptionalA detailed description of why the case was rejected. Only available if the case status is REJECTED.
rejection_reasonstringOptionalThe reason why the case was rejected. Only available if the case status is REJECTED.
statusstringOptionalStatus of the current active process.
Known values: CANCELLED, AWAITING_DOCUMENTS, IN_REVIEW, APPROVED, REJECTED

Upload a required immigration document — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Upload a required immigration document — 201 response body — data

Referenced models: Upload a required immigration document — 201 response body — data

Upload a required immigration document — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation date of the document.
Format: date-time
idstringOptionalUnique identifier of the document.
statusstringOptionalStatus of the document.
Known values: IN_REVIEW
updated_atstringOptionalLast update date of the document.
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.