Deel: Immigration schemas
76 Deel schemas with complete fields and constraints.
← Immigration operations · All schemas
Approve a visa application quote — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_id | string | Required within parent | The unique identifier of the eligibility check case the visa application quote was proposed on. Format: uuid |
created_at | string | Required within parent | UTC timestamp when the visa application quote was created. Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Approval details of the visa application quote. |
description (anyOf 2) | null | Alternative | Approval details of the visa application quote. |
due_date | JSON | Required within parent | |
due_date (anyOf 1) | string | Alternative | UTC timestamp by which the quoted fees are due once approved. Format: date-time |
due_date (anyOf 2) | null | Alternative | UTC timestamp by which the quoted fees are due once approved. Format: date-time |
generated_case_id | JSON | Required within parent | |
generated_case_id (anyOf 1) | string | Alternative | The 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) | null | Alternative | The unique identifier of the visa application case opened when the visa application quote was approved. Null while it is in review. Format: uuid |
id | string | Required within parent | The unique identifier of the visa application quote. Format: uuid |
items | array | Required within parent | The fees that make up the visa application quote. |
items[] | Model | Each item | Expand Approve a visa application quote — 200 response body — data items item |
status | string | Required within parent | IN_REVIEW while the visa application quote waits for the organization to approve it, APPROVED once approved. Known values: IN_REVIEW, APPROVED |
updated_at | string | Required within parent | UTC 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Amount of the fee. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | ISO 4217 currency code of the fee. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the quoted fee. |
description (anyOf 2) | null | Alternative | Description of the quoted fee. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the quoted fee. |
name (anyOf 2) | null | Alternative | Name of the quoted fee. |
Create an immigration case for a contract — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | JSON | Required within parent | The worker the case is for. |
applicant (anyOf 1) | Model | Alternative | Expand Create an immigration case for a contract — 201 response body — data applicant The worker the case is for |
applicant (anyOf 2) | null | Alternative | |
business_trip | JSON | Required within parent | The business trip of a business visa case. Null for other cases. |
business_trip (anyOf 1) | Model | Alternative | Expand Create an immigration case for a contract — 201 response body — data business trip end date, reason, start date |
business_trip (anyOf 2) | null | Alternative | |
case_type | Model | Required within parent | Expand Create an immigration case for a contract — 201 response body — data case type The case type the case was opened with. |
citizenships | array | Required within parent | ISO 3166-1 alpha-2 codes of the worker citizenships known to the case. |
citizenships[] | string | Each item | |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | UTC timestamp when the case was closed. Null while the case is not closed. Format: date-time |
closed_at (anyOf 2) | null | Alternative | UTC timestamp when the case was closed. Null while the case is not closed. Format: date-time |
closure | JSON | Required within parent | Why the case was closed. Null while the case is not closed. |
closure (anyOf 1) | Model | Alternative | Expand Create an immigration case for a contract — 201 response body — data closure note, reason |
closure (anyOf 2) | null | Alternative | |
contract_id | JSON | Required within parent | |
contract_id (anyOf 1) | string | Alternative | The contract the case was opened for. |
contract_id (anyOf 2) | null | Alternative | The contract the case was opened for. |
contract_type | JSON | Required within parent | |
contract_type (anyOf 1) | string | Alternative | Type of contract behind the case, for example EOR, COR, CONTRACTOR, DIRECT_EMPLOYEE, PWAC. New values may be added. |
contract_type (anyOf 2) | null | Alternative | Type of contract behind the case, for example EOR, COR, CONTRACTOR, DIRECT_EMPLOYEE, PWAC. New values may be added. |
converted_to_case_id | JSON | Required within parent | |
converted_to_case_id (anyOf 1) | string | Alternative | The case this case was converted into, when it was. |
converted_to_case_id (anyOf 2) | null | Alternative | The case this case was converted into, when it was. |
country_code | string | Required within parent | ISO 3166-1 alpha-2 code of the destination country. |
created_at | string | Required within parent | UTC timestamp when the case was created. Format: date-time |
estimated_completion_date | JSON | Required within parent | |
estimated_completion_date (anyOf 1) | string | Alternative | Date the case is expected to be completed. Format: date |
estimated_completion_date (anyOf 2) | null | Alternative | Date the case is expected to be completed. Format: date |
filing_type | JSON | Required within parent | Whether the case is an initial filing, a renewal or another filing. |
filing_type (anyOf 1) | string | Alternative | Whether the case is an initial filing, a renewal or another filing. Known values: INITIAL, RENEWAL, CHANGE_OF_EMPLOYER, REFILING |
filing_type (anyOf 2) | null | Alternative | |
full_status | string | Required within parent | Status of the case including how a closed case ended. Known values: OPEN, ON_HOLD, CLOSED_POSITIVELY, CLOSED_NEGATIVELY, CLOSED_NEUTRALLY |
id | string | Required within parent | The unique identifier of the case. Format: uuid |
is_onboarding | boolean | Required within parent | Whether the case is part of the worker onboarding. |
parent_case_id | JSON | Required within parent | |
parent_case_id (anyOf 1) | string | Alternative | The case of the main applicant when this is a dependent case. |
parent_case_id (anyOf 2) | null | Alternative | The case of the main applicant when this is a dependent case. |
reference_id | JSON | Required within parent | |
reference_id (anyOf 1) | string | Alternative | Human-readable reference of the case. Null for cases opened before references existed. |
reference_id (anyOf 2) | null | Alternative | Human-readable reference of the case. Null for cases opened before references existed. |
sponsoring_entity_id | JSON | Required within parent | |
sponsoring_entity_id (anyOf 1) | string | Alternative | Legal entity sponsoring the visa when the client sponsors it. |
sponsoring_entity_id (anyOf 2) | null | Alternative | Legal entity sponsoring the visa when the client sponsors it. |
sponsorship | JSON | Required within parent | Who sponsors the visa. Null when unknown or not applicable. |
sponsorship (anyOf 1) | string | Alternative | Who sponsors the visa. Null when unknown or not applicable. Known values: DEEL, CLIENT, NO_SPONSORSHIP |
sponsorship (anyOf 2) | null | Alternative | |
status | string | Required within parent | Current status of the case. Known values: OPEN, CLOSED, ON_HOLD |
updated_at | string | Required within parent | UTC timestamp when the case was last updated. Format: date-time |
visa_category | JSON | Required within parent | Visa category of the case. Null when the case is not about a visa. |
visa_category (anyOf 1) | string | Alternative | Visa category of the case. Null when the case is not about a visa. Known values: BUSINESS_VISA, WORK_PERMIT_VISA |
visa_category (anyOf 2) | null | Alternative | |
visa_management_fee | JSON | Required within parent | The 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) | Model | Alternative | Expand 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) | null | Alternative | |
visa_type | JSON | Required within parent | The visa type of the case. Null while none is chosen. |
visa_type (anyOf 1) | Model | Alternative | Expand Create an immigration case for a contract — 201 response body — data visa type id, name |
visa_type (anyOf 2) | null | Alternative | |
work_type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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_type | string | Required within parent | The kind of visa management fee. Known values: FULL_IMMIGRATION_MANAGEMENT_FEE |
projected_amount | JSON | Required within parent | |
projected_amount (anyOf 1) | JSON | Alternative | |
projected_amount (anyOf 1) (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projected_amount (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker the case is for. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Full name of the worker. |
name (anyOf 2) | null | Alternative | Full name of the worker. |
worker_id | string | Required within parent | The unique identifier of the worker. |
Create an immigration case for a contract — 201 response body — data business trip end date, reason, start date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The business trip of a business visa case. Null for other cases. |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Last day of the trip. Format: date |
end_date (anyOf 2) | null | Alternative | Last day of the trip. Format: date |
reason | JSON | Required within parent | |
reason (anyOf 1) | string | Alternative | Why the worker travels. |
reason (anyOf 2) | null | Alternative | Why the worker travels. |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | First day of the trip. Format: date |
start_date (anyOf 2) | null | Alternative | First day of the trip. Format: date |
Create an immigration case for a contract — 201 response body — data case type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The case type the case was opened with. |
id | string | Required within parent | The unique identifier. |
name | string | Required within parent | The display name. |
Create an immigration case for a contract — 201 response body — data closure note, reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Why the case was closed. Null while the case is not closed. |
note | JSON | Required within parent | |
note (anyOf 1) | string | Alternative | Additional details about the closure. |
note (anyOf 2) | null | Alternative | Additional details about the closure. |
reason | JSON | Required within parent | |
reason (anyOf 1) | string | Alternative | Reason the case was closed or rejected. |
reason (anyOf 2) | null | Alternative | Reason the case was closed or rejected. |
Create an immigration case for a contract — 201 response body — data visa type id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The visa type of the case. Null while none is chosen. |
id | string | Required within parent | The unique identifier. |
name | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The trip to check. Required for BUSINESS_VISA, not allowed otherwise. |
end_date | string | Required within parent | Last day of the trip, not before start_date. Format: date |
reason | string | Required within parent | Why the worker travels. Maximum length: 250 Minimum length: 1 |
start_date | string | Required within parent | First day of the trip, today or later. Format: date |
Create an immigration case for a contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The case to open, chosen by work_type. discriminator: {"propertyName": "work_type"} |
$ (oneOf 1) | object | Alternative | Opens an eligibility check for a work permit or a business visa. |
$ (oneOf 1).business_trip | Model | Optional | Expand 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_id | string | Required within parent | The contract of the worker the case is for. Maximum length: 50 Pattern: ^[A-Za-z0-9_-]+$ |
$ (oneOf 1).country | string | Required within parent | ISO 3166-1 alpha-2 code of the destination country. Maximum length: 2 |
$ (oneOf 1).visa_category | string | Required within parent | The visa category to check eligibility for. One of: BUSINESS_VISA, WORK_PERMIT_VISA |
$ (oneOf 1).work_type | string | Required within parent | Discriminator value: ELIGIBILITY_CHECK One of: ELIGIBILITY_CHECK |
$ (oneOf 2) | object | Alternative | Opens a right to work check with the worker's nationality from the contract. |
$ (oneOf 2).contract_id | string | Required within parent | The contract of the worker the case is for. Maximum length: 50 Pattern: ^[A-Za-z0-9_-]+$ |
$ (oneOf 2).country | string | Required within parent | ISO 3166-1 alpha-2 code of the destination country. Maximum length: 2 |
$ (oneOf 2).work_type | string | Required within parent | Discriminator 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The immigration case data returned after successful creation |
closure_note | JSON | Optional | |
closure_note (anyOf 1) | string | Alternative | Optional note explaining why the case was closed Maximum length: 400 |
closure_note (anyOf 2) | null | Alternative | Optional note explaining why the case was closed Maximum length: 400 |
closure_reason | JSON | Optional | |
closure_reason (anyOf 1) | string | Alternative | Standardized reason for case closure |
closure_reason (anyOf 2) | null | Alternative | Standardized reason for case closure |
created_at | string | Required within parent | Timestamp when the case was created Format: date-time |
id | string | Required within parent | Unique identifier for the case Format: uuid |
process | Model | Required within parent | Expand Create an immigration case — 201 response body — data process Details about the current immigration process associated with the case |
status | string | Required within parent | Current status of the case Known values: OPEN, CLOSED, ON_HOLD |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the current immigration process associated with the case |
id | string | Required within parent | Unique identifier for the process Format: uuid |
process_name | string | Required within parent | Name of the immigration process |
status_name | string | Required within parent | Human-readable status of the process |
Create an immigration case — request body — body / data / case_type: BUSINESS VISA
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_type | string | Required within parent | The type of immigration case to be created. Determines the workflow and requirements One of: BUSINESS_VISA |
contract_id | string | Optional | The 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_code | string | Required within parent | ISO 3166-1 alpha-2 country code where the immigration case needs to be processed Maximum length: 2 |
employee_details | Model | Required within parent | Expand 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_id | string | Optional | The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications Format: uuid |
team_id | string | Optional | The id of the team for which the employee will be added to. Required if contract_id is not provided Format: uuid |
travel_information | Model | Required within parent | Expand Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information Travel details for the business visa |
visa_type_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
citizenships | array | Required within parent | List of ISO 3166-1 alpha-2 country codes representing employee's citizenships |
citizenships[] | string | Each item | Maximum length: 2 Minimum length: 2 |
email | string | Optional | Employee's email address. Required if contract_id is not provided Format: email Maximum length: 255 Minimum length: 3 |
first_name | string | Optional | Employee's first name. Required if contract_id is not provided Maximum length: 100 Minimum length: 3 |
last_name | string | Optional | Employee's last name. Required if contract_id is not provided Maximum length: 100 Minimum length: 3 |
residence | string | Required within parent | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Travel details for the business visa |
end_date | string | Required within parent | Trip end date in YYYY-MM-DD format Format: date |
purpose | Model | Required within parent | Expand Create an immigration case — request body — body / data / case_type: BUSINESS VISA travel information purpose The purpose of the business trip |
start_date | string | Required within parent | Trip 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_type | string | Required within parent | The type of immigration case to be created. Determines the workflow and requirements One of: EOR_VISA |
contract_id | string | Required within parent | The contract object identifier. Required for document reviews and visa applications Maximum length: 20 |
country_code | string | Required within parent | ISO 3166-1 alpha-2 country code where the immigration case needs to be processed Maximum length: 2 |
visa_type_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_type | string | Required within parent | The type of immigration case to be created. Determines the workflow and requirements One of: PRE_HIRE_EOR_VISA |
country_code | string | Required within parent | ISO 3166-1 alpha-2 country code where the immigration case needs to be processed Maximum length: 2 |
team_id | string | Required within parent | The unique identifier of the team for which the pre-hire visa case is being created Format: uuid |
visa_type_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_type | string | Required within parent | The type of immigration case to be created. Determines the workflow and requirements One of: PRE_HIRE_SPONSORSHIP_VISA |
country_code | string | Required within parent | ISO 3166-1 alpha-2 country code where the immigration case needs to be processed Maximum length: 2 |
entity_id | string | Optional | The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications Format: uuid |
team_id | string | Required within parent | The unique identifier of the team for which the pre-hire sponsorship visa case is being created Format: uuid |
visa_type_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_type | string | Required within parent | The type of immigration case to be created. Determines the workflow and requirements One of: RIGHT_TO_WORK |
contract_id | string | Required within parent | The contract object identifier. Required for document reviews and visa applications Maximum length: 20 |
country_code | string | Required within parent | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_type | string | Required within parent | The type of immigration case to be created. Determines the workflow and requirements One of: SPONSORED_VISA |
contract_id | string | Required within parent | The contract object identifier. Required for document reviews and visa applications Maximum length: 20 |
country_code | string | Required within parent | ISO 3166-1 alpha-2 country code where the immigration case needs to be processed Maximum length: 2 |
entity_id | string | Required within parent | The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications Format: uuid |
visa_type_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | Model | Alternative | Expand Create an immigration case — request body — body / data / case_type: RIGHT TO WORK |
$ (oneOf 2) | Model | Alternative | Expand Create an immigration case — request body — body / data / case_type: EOR VISA |
$ (oneOf 3) | Model | Alternative | Expand Create an immigration case — request body — body / data / case_type: SPONSORED VISA |
$ (oneOf 4) | Model | Alternative | Expand Create an immigration case — request body — body / data / case_type: PRE HIRE EOR VISA |
$ (oneOf 5) | Model | Alternative | Expand Create an immigration case — request body — body / data / case_type: PRE HIRE SPONSORSHIP VISA |
$ (oneOf 6) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the visa type |
estimated_timeline | JSON | Required within parent | Estimated processing timeline, in weeks, months or years |
estimated_timeline (anyOf 1) | string | Alternative | Estimated 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) | null | Alternative | |
fee | JSON | Required within parent | |
fee (anyOf 1) | JSON | Alternative | |
fee (anyOf 1) (anyOf 1) | number | Alternative | Fee amount Format: double |
fee (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fee (anyOf 2) | null | Alternative | Fee amount Format: double |
fee_currency | JSON | Required within parent | |
fee_currency (anyOf 1) | string | Alternative | Currency code for the fee in ISO 4217 format Pattern: ^[A-Z]{3}$ |
fee_currency (anyOf 2) | null | Alternative | Currency code for the fee in ISO 4217 format Pattern: ^[A-Z]{3}$ |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the visa type |
name (anyOf 2) | null | Alternative | Name of the visa type |
qualification | string | Required within parent | Visa 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_id | JSON | Required within parent | |
visa_type_id (anyOf 1) | string | Alternative | Unique 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) | null | Alternative | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get case timeline — 200 response body — data |
Referenced models: Get case timeline — 200 response body — data
Get case timeline — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ongoing_actions | JSON | Required within parent | |
ongoing_actions (anyOf 1) | integer | Alternative | Number of actions currently waiting on the client or the employee. |
ongoing_actions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processes | array | Required within parent | Processes of the case in order. |
processes[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the process. |
name | string | Required within parent | Display name of the process. |
state | string | Required within parent | Whether the process is not started, active or completed. Known values: ACTIVE, COMPLETED, NOT_STARTED |
steps | array | Required within parent | Steps of the process in order. |
steps[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actions | array | Required within parent | Actions attached to the step, earliest due first. |
actions[] | Model | Each item | Expand Get case timeline — 200 response body — data processes item steps item actions item |
activated_at | JSON | Required within parent | |
activated_at (anyOf 1) | string | Alternative | UTC timestamp when the step became active. Null while the step has not started. Format: date-time |
activated_at (anyOf 2) | null | Alternative | UTC timestamp when the step became active. Null while the step has not started. Format: date-time |
completed_at | JSON | Required within parent | |
completed_at (anyOf 1) | string | Alternative | UTC timestamp when the step was completed. Null while the step is open. Format: date-time |
completed_at (anyOf 2) | null | Alternative | UTC timestamp when the step was completed. Null while the step is open. Format: date-time |
id | string | Required within parent | The unique identifier of the step. |
name | string | Required within parent | Display name of the step. |
state | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed_at | JSON | Required within parent | |
completed_at (anyOf 1) | string | Alternative | UTC timestamp when the action was completed. Null while the action is open. Format: date-time |
completed_at (anyOf 2) | null | Alternative | UTC timestamp when the action was completed. Null while the action is open. Format: date-time |
description | string | Required within parent | What the assigned party has to do. |
due_date | JSON | Required within parent | |
due_date (anyOf 1) | string | Alternative | UTC timestamp by which the action is expected to be completed. Format: date-time |
due_date (anyOf 2) | null | Alternative | UTC timestamp by which the action is expected to be completed. Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | The unique identifier of the action. |
id (anyOf 2) | null | Alternative | The unique identifier of the action. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Short title of the action. |
name (anyOf 2) | null | Alternative | Short title of the action. |
status | JSON | Required within parent | Progress of the action. |
status (anyOf 1) | string | Alternative | Progress of the action. Known values: TODO, ONGOING, COMPLETED, ARCHIVED |
status (anyOf 2) | null | Alternative | |
type | Model | Required within parent | Expand Get case timeline — 200 response body — data processes item steps item actions item type The kind of action expected from the assigned party. |
user_type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | JSON | Optional | |
applicant (anyOf 1) | Model | Alternative | Expand Get immigration case details — 200 response body — data applicant external id, id |
applicant (anyOf 2) | null | Alternative | |
case_created_at | string | Optional | Creation date of the immigration case. Format: date-time |
case_type | string | Optional | Name of the case type |
country_code | string | Optional | The country of the immigration case. |
documents | array | Optional | |
documents[] | Model | Each item | Expand Get immigration case details — 200 response body — data documents item |
estimated_completion_date | JSON | Optional | |
estimated_completion_date (anyOf 1) | string | Alternative | Estimated completion date of the immigration case. Format: date-time |
estimated_completion_date (anyOf 2) | null | Alternative | Estimated completion date of the immigration case. Format: date-time |
id | string | Optional | Unique identifier of immigration case. |
last_update_at | string | Optional | Last activity on the immigration case. Format: date-time |
process | Model | Optional | Expand Get immigration case details — 200 response body — data process |
status | string | Optional | Status of the immigration case. Known values: OPEN, CLOSED, ON_HOLD |
visa_type | JSON | Optional | |
visa_type (anyOf 1) | string | Alternative | The type of the the visa. |
visa_type (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | External identifier of the applicant. |
external_id (anyOf 2) | null | Alternative | External identifier of the applicant. |
id | string | Optional | Unique identifier of the applicant profile id. |
Get immigration case details — 200 response body — data documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_type | JSON | Optional | |
document_type (anyOf 1) | string | Alternative | The type of the document. Represents the visa type for right to work cases. |
document_type (anyOf 2) | null | Alternative | The type of the document. Represents the visa type for right to work cases. |
expiration_date | JSON | Optional | |
expiration_date (anyOf 1) | string | Alternative | Expiry date of the document. Format: date-time |
expiration_date (anyOf 2) | null | Alternative | Expiry date of the document. Format: date-time |
id | string | Optional | Unique identifier of the document. |
status | string | Optional | Status of the document. Known values: IN_REVIEW, ACTIVE, EXPIRED, EXPIRING, UNKNOWN |
Get immigration case details — 200 response body — data process
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier of the current active process. |
name | string | Optional | Name of the current active process. |
status | string | Optional | Status of the current active process. |
Get specific immigration case details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | JSON | Optional | The employee for which this Right to Work case has been created for |
applicant (anyOf 1) | Model | Alternative | Expand Get specific immigration case details — 200 response body — data applicant external id, id |
applicant (anyOf 2) | null | Alternative | |
case_type | string | Optional | Type of the case. |
contract | Model | Optional | Expand Get specific immigration case details — 200 response body — data contract The contract associated with the returned immigration case |
country_code | string | Optional | The country of the immigration case. |
created_at | string | Optional | Creation date of the immigration case. Format: date-time |
documents | array | Optional | A list of documents associated to the immigration case |
documents[] | Model | Each item | Expand Get specific immigration case details — 200 response body — data documents item |
estimated_completion_date | JSON | Optional | |
estimated_completion_date (anyOf 1) | string | Alternative | Estimated completion date of the immigration case. Format: date-time |
estimated_completion_date (anyOf 2) | null | Alternative | Estimated completion date of the immigration case. Format: date-time |
id | string | Optional | Unique identifier of immigration case. |
process | Model | Optional | Expand Get specific immigration case details — 200 response body — data process The current active process |
status | string | Optional | Status of the immigration case. Known values: OPEN, CLOSED, ON_HOLD |
updated_at | string | Optional | Last activity on the immigration case. Format: date-time |
visa_type | JSON | Optional | |
visa_type (anyOf 1) | string | Alternative | The type of the visa. |
visa_type (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The employee for which this Right to Work case has been created for |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | External identifier of the applicant (from partner system or third party). |
external_id (anyOf 2) | null | Alternative | External identifier of the applicant (from partner system or third party). |
id | string | Optional | Unique identifier of the applicant profile id. |
Get specific immigration case details — 200 response body — data contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The contract associated with the returned immigration case |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Id of the contract associated with the immigration case |
id (anyOf 2) | null | Alternative | Id of the contract associated with the immigration case |
Get specific immigration case details — 200 response body — data documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_type | JSON | Optional | |
document_type (anyOf 1) | string | Alternative | The type of the document. Represents the visa type for right to work cases. |
document_type (anyOf 2) | null | Alternative | The type of the document. Represents the visa type for right to work cases. |
expiration_date | JSON | Optional | |
expiration_date (anyOf 1) | string | Alternative | Expiry date of the document. If document does not expire, it will be null Format: date-time |
expiration_date (anyOf 2) | null | Alternative | Expiry date of the document. If document does not expire, it will be null Format: date-time |
id | string | Optional | Unique identifier of the document. |
status | string | Optional | Status 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current active process |
id | string | Optional | Unique identifier of the current active process. |
name | string | Optional | Name of the current active process. |
rejection_note | string | Optional | A detailed description of why the case was rejected. Only available if the case status is REJECTED. |
rejection_reason | string | Optional | The reason why the case was rejected. Only available if the case status is REJECTED. |
status | string | Optional | Status of the current active process. |
Immigration document — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Immigration document — 200 response body — data |
Referenced models: Immigration document — 200 response body — data
Immigration document — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_type | JSON | Optional | |
document_type (anyOf 1) | string | Alternative | The type of the document. Represents the visa type for right to work cases. |
document_type (anyOf 2) | null | Alternative | The type of the document. Represents the visa type for right to work cases. |
download_link | array | Optional | S3 download link of all the files uploaded within current document record. |
download_link[] | string | Each item | |
expiration_date | JSON | Optional | |
expiration_date (anyOf 1) | string | Alternative | Expiry date of the document. Format: date-time |
expiration_date (anyOf 2) | null | Alternative | Expiry date of the document. Format: date-time |
id | string | Optional | The UUID of document entity. |
status | JSON | Optional | Current status of the document. |
status (anyOf 1) | string | Alternative | Current status of the document. Known values: IN_REVIEW, APPROVED, REJECTED |
status (anyOf 2) | null | Alternative |
Immigration visa types — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier of a visa type. |
name | string | Optional | The name of a visa. |
List case invoices — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List case invoices — 200 response body — data item |
has_more | boolean | Required within parent | Whether more items are available beyond this page. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to pass as cursor to fetch the next page. Null when there is no next page. |
next_cursor (anyOf 2) | null | Alternative | Cursor to pass as cursor to fetch the next page. Null when there is no next page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | JSON | Alternative | |
total_count (anyOf 1) (anyOf 1) | integer | Alternative | Total number of invoices issued to the organization for the case. |
total_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count (anyOf 2) | null | Alternative | Total 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Invoiced amount in the invoice currency. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | ISO 4217 currency code of the invoiced amount. |
due_date | string | Required within parent | UTC timestamp by which the invoice is due. Format: date-time |
id | string | Required within parent | The public identifier of the invoice, as shown in the Deel platform. |
is_paid | boolean | Required within parent | Whether the invoice has been settled. |
issued_at | string | Required within parent | UTC timestamp when the invoice was issued. Format: date-time |
paid_at | JSON | Required within parent | |
paid_at (anyOf 1) | string | Alternative | UTC timestamp when the invoice was paid. Null while unpaid. Format: date-time |
paid_at (anyOf 2) | null | Alternative | UTC timestamp when the invoice was paid. Null while unpaid. Format: date-time |
quote_id | string | Required within parent | The unique identifier of the quote the invoice was issued for. Format: uuid |
status | string | Required within parent | Payment 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List case notes — 200 response body — data item |
has_more | boolean | Required within parent | Whether more notes are available beyond this page. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to pass as cursor to fetch the next page. Null when there is no next page. |
next_cursor (anyOf 2) | null | Alternative | Cursor to pass as cursor to fetch the next page. Null when there is no next page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | JSON | Alternative | |
total_count (anyOf 1) (anyOf 1) | integer | Alternative | Total number of externally-visible notes for the case, when available. |
total_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count (anyOf 2) | null | Alternative | Total 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | UTC timestamp when the note was created. Format: date-time |
id | string | Required within parent | The unique identifier of the note. |
message | string | Required within parent | Note content. |
note_type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of cases in the current page. |
data[] | Model | Each item | Expand List of immigration cases for workers — 200 response body — data item |
has_more | boolean | Required within parent | Indicates whether more results are available for pagination. |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | Cursor value to be used for fetching the next page of results. |
next_cursor (anyOf 2) | null | Alternative | Cursor value to be used for fetching the next page of results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of cases matching the search criteria. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | JSON | Required within parent | Applicant associated with the immigration case. |
applicant (anyOf 1) | Model | Alternative | Expand List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case |
applicant (anyOf 2) | null | Alternative | |
case_type | Model | Required within parent | Expand List of immigration cases — 200 response body — data item case type Type of immigration case. |
closure | JSON | Required within parent | Closure details of the case if the case has been closed. |
closure (anyOf 1) | Model | Alternative | Expand List of immigration cases for workers — 200 response body — data item closure note, reason |
closure (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp indicating when the case was created. Format: date-time |
id | string | Required within parent | Unique identifier of the immigration case. Format: uuid |
process | Model | Required within parent | Expand List of immigration cases — 200 response body — data item process Current active process associated with the case. |
status | string | Required within parent | Current lifecycle status of the immigration case. Known values: OPEN, CLOSED, ON_HOLD |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Closure details of the case if the case has been closed. |
note | JSON | Required within parent | |
note (anyOf 1) | string | Alternative | Additional notes explaining the case closure. Maximum length: 400 |
note (anyOf 2) | null | Alternative | Additional notes explaining the case closure. Maximum length: 400 |
reason | JSON | Required within parent | Reason why the immigration case was closed. |
reason (anyOf 1) | string | Alternative | Reason why the immigration case was closed. Known values: CONTRACT_CANCELLED, NATIONALITY_CHANGE, NEW_CASE_TYPE_IS_REQUIRED, ONBOARDING_RELEASED, OTHER |
reason (anyOf 2) | null | Alternative |
List of immigration cases — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of cases in the current page. |
data[] | Model | Each item | Expand List of immigration cases — 200 response body — data item |
has_more | boolean | Required within parent | Indicates whether more results are available for pagination. |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | Cursor value to be used for fetching the next page of results. |
next_cursor (anyOf 2) | null | Alternative | Cursor value to be used for fetching the next page of results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of cases matching the search criteria. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | JSON | Required within parent | Applicant associated with the immigration case. |
applicant (anyOf 1) | Model | Alternative | Expand List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case |
applicant (anyOf 2) | null | Alternative | |
case_type | Model | Required within parent | Expand List of immigration cases — 200 response body — data item case type Type of immigration case. |
closure | JSON | Required within parent | Closure details of the case if the case has been closed. |
closure (anyOf 1) | Model | Alternative | Expand List of immigration cases — 200 response body — data item closure note, reason |
closure (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp indicating when the case was created. Format: date-time |
id | string | Required within parent | Unique identifier of the immigration case. Format: uuid |
process | Model | Required within parent | Expand List of immigration cases — 200 response body — data item process Current active process associated with the case. |
status | string | Required within parent | Current lifecycle status of the immigration case. Known values: OPEN, CLOSED, ON_HOLD |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Applicant associated with the immigration case. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the applicant. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of the applicant. Format: uuid |
name | string | Required within parent | Full name of the applicant. Maximum length: 255 |
List of immigration cases — 200 response body — data item case type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Type of immigration case. |
id | string | Required within parent | Unique identifier of the case type. Format: uuid |
name | string | Required within parent | Human-readable name of the case type. Maximum length: 255 |
List of immigration cases — 200 response body — data item closure note, reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Closure details of the case if the case has been closed. |
note | JSON | Required within parent | |
note (anyOf 1) | string | Alternative | Additional notes explaining the case closure. Maximum length: 400 |
note (anyOf 2) | null | Alternative | Additional notes explaining the case closure. Maximum length: 400 |
reason | JSON | Required within parent | Reason why the immigration case was closed. |
reason (anyOf 1) | string | Alternative | Reason 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) | null | Alternative |
List of immigration cases — 200 response body — data item process
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current active process associated with the case. |
id | string | Required within parent | Unique identifier of the current process. Format: uuid |
name | string | Required within parent | Human-readable name of the current process step. Maximum length: 255 |
status | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current status of the process. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of the process status. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of the process status. Format: uuid |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Human-readable name of the process status. Maximum length: 255 |
name (anyOf 2) | null | Alternative | Human-readable name of the process status. Maximum length: 255 |
List of immigration cases — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
search | string | Optional | Maximum length: 100 Minimum length: 3 |
case_type_ids | array | Optional | |
case_type_ids[] | string | Each item | Format: uuid |
statuses | array | Optional | |
statuses[] | string | Each item | One of: OPEN, ON_HOLD, CLOSED |
countries | array | Optional | |
countries[] | string | Each item | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
cursor | string | Optional | |
limit | integer | Optional | Default: 20 Maximum: 100 |
Retrieve a required document for a case — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation date of the document request. Format: date-time |
description | string | Optional | A short text description of the document requirement to be uploaded. |
document | Model | Optional | Expand Retrieve a required document for a case — 200 response body — data document |
id | string | Optional | The unique identifier of the document requirement. |
immigration_document_requirement_id | string | Optional | The unique identifier of the immigration document requirement. |
name | string | Optional | The name of the document requirement to be uploaded. |
previous_rejected_document | Model | Optional | Expand Retrieve a required document for a case — 200 response body — data previous rejected document |
updated_at | string | Optional | Last 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expiration_date | JSON | Optional | |
expiration_date (anyOf 1) | string | Alternative | Expiration date of the document. If document does not expire, it will be null Format: date-time |
expiration_date (anyOf 2) | null | Alternative | Expiration date of the document. If document does not expire, it will be null Format: date-time |
id | string | Optional | Unique identifier of the document. |
name | string | Optional | The name of the document. |
status | string | Optional | Status 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier of the document. |
rejection_note | JSON | Optional | |
rejection_note (anyOf 1) | string | Alternative | A detailed description about why the document was rejected. |
rejection_note (anyOf 2) | null | Alternative | A detailed description about why the document was rejected. |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | The reason why the document was rejected. |
rejection_reason (anyOf 2) | null | Alternative | The reason why the document was rejected. |
status | string | Optional | Status of the document. Known values: REJECTED |
Retrieve the legacy onboarding right-to-work case for a worker — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | JSON | Optional | The employee for which this Right to Work case has been created for |
applicant (anyOf 1) | Model | Alternative | Expand Get specific immigration case details — 200 response body — data applicant external id, id |
applicant (anyOf 2) | null | Alternative | |
case_type | string | Optional | Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint. Known values: IMMIGRATION_DOCUMENT_REVIEW |
contract | Model | Optional | Expand Get specific immigration case details — 200 response body — data contract The contract associated with the returned immigration case |
country_code | string | Optional | The country of the immigration case. |
created_at | string | Optional | Creation date of the immigration case. Format: date-time |
documents | array | Optional | A list of documents associated to the immigration case |
documents[] | Model | Each item | Expand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item |
estimated_completion_date | JSON | Optional | |
estimated_completion_date (anyOf 1) | string | Alternative | Estimated completion date of the immigration case. Format: date-time |
estimated_completion_date (anyOf 2) | null | Alternative | Estimated completion date of the immigration case. Format: date-time |
id | string | Optional | Unique identifier of immigration case. |
process | Model | Optional | Expand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process The current active process |
status | string | Optional | Status of the immigration case. Known values: OPEN, CLOSED, ON_HOLD |
updated_at | string | Optional | Last activity on the immigration case. Format: date-time |
visa_type | JSON | Optional | |
visa_type (anyOf 1) | string | Alternative | The type of the visa. |
visa_type (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_type | JSON | Optional | |
document_type (anyOf 1) | string | Alternative | The type of the document. Represents the visa type for right to work cases. |
document_type (anyOf 2) | null | Alternative | The type of the document. Represents the visa type for right to work cases. |
expiration_date | JSON | Optional | |
expiration_date (anyOf 1) | string | Alternative | Expiry date of the document. If document does not expire, it will be null Format: date-time |
expiration_date (anyOf 2) | null | Alternative | Expiry date of the document. If document does not expire, it will be null Format: date-time |
id | string | Optional | Unique identifier of the document. |
status | string | Optional | Status 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current active process |
id | string | Optional | Unique identifier of the current active process. |
name | string | Optional | Name of the current active process. Known values: WORK_AUTHORIZATION_VERIFICATION |
rejection_note | string | Optional | A detailed description of why the case was rejected. Only available if the case status is REJECTED. |
rejection_reason | string | Optional | The reason why the case was rejected. Only available if the case status is REJECTED. |
status | string | Optional | Status of the current active process. Known values: CANCELLED, AWAITING_DOCUMENTS, IN_REVIEW, APPROVED, REJECTED |
Upload a required immigration document — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation date of the document. Format: date-time |
id | string | Optional | Unique identifier of the document. |
status | string | Optional | Status of the document. Known values: IN_REVIEW |
updated_at | string | Optional | Last update date of the document. Format: date-time |