# Schemas

## The StartOnboardingResult object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"StartOnboardingResult":{"title":"StartOnboardingResult","type":"object","properties":{"onboardingId":{"type":"string","format":"uuid","readOnly":true}},"required":["onboardingId"]}}}}
```

## The StartOffboardingResult object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"StartOffboardingResult":{"title":"StartOffboardingResult","type":"object","properties":{"offboardingId":{"type":"string","format":"uuid","readOnly":true}},"required":["offboardingId"]}}}}
```

## The OnboardingData object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OnboardingData":{"title":"OnboardingData","type":"object","properties":{"entityType":{"$ref":"#/components/schemas/OnboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of customer, proxy, beneficial owner or partner depending on the value of `entityType`"}},"required":["entityType","entityId"],"description":""},"OnboardingEntityTypeEnum":{"title":"OnboardingEntityTypeEnum","type":"string","enum":["CUSTOMER","PROXY","BENEFICIAL_OWNER","PARTNER_USER"]}}}}
```

## The OffboardingData object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OffboardingData":{"title":"OffboardingData","type":"object","properties":{"entityType":{"$ref":"#/components/schemas/OffboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of customer, proxy or beneficial owner depending on the value of `entityType`"},"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"}},"required":["entityType","entityId","reason"],"description":""},"OffboardingEntityTypeEnum":{"title":"OffboardingEntityTypeEnum","type":"string","enum":["CUSTOMER","PROXY","BENEFICIAL_OWNER"]},"OffboardingReasonEnum":{"title":"OffboardingReasonEnum","type":"string","enum":["CUSTOMER_REQUEST_IMMEDIATE","CANCELLATION_BY_PARTNER_ORDINARY","CANCELLATION_BY_PARTNER_IMMEDIATE","DEATH_IMMEDIATE","DISSOLUTION_IMMEDIATE","INSOLVENCY_IMMEDIATE","COMPANY_STRUCTURE_CHANGES_IMMEDIATE"]}}}}
```

## The OffboardingReasonEnum object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OffboardingReasonEnum":{"title":"OffboardingReasonEnum","type":"string","enum":["CUSTOMER_REQUEST_IMMEDIATE","CANCELLATION_BY_PARTNER_ORDINARY","CANCELLATION_BY_PARTNER_IMMEDIATE","DEATH_IMMEDIATE","DISSOLUTION_IMMEDIATE","INSOLVENCY_IMMEDIATE","COMPANY_STRUCTURE_CHANGES_IMMEDIATE"]}}}}
```

## The OnboardingEntityTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OnboardingEntityTypeEnum":{"title":"OnboardingEntityTypeEnum","type":"string","enum":["CUSTOMER","PROXY","BENEFICIAL_OWNER","PARTNER_USER"]}}}}
```

## The OffboardingEntityTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OffboardingEntityTypeEnum":{"title":"OffboardingEntityTypeEnum","type":"string","enum":["CUSTOMER","PROXY","BENEFICIAL_OWNER"]}}}}
```

## The OnboardingStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OnboardingStatusEnum":{"title":"OnboardingStatusEnum","type":"string","enum":["CREATED","PENDING","APPROVED","REJECTED","RECEIVED","INVALID"],"readOnly":true}}}}
```

## The OffboardingStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OffboardingStatusEnum":{"title":"OffboardingStatusEnum","type":"string","enum":["RECEIVED","CREATED","PENDING","INVALID","REJECTED","CANCELED","APPROVED"],"readOnly":true}}}}
```

## The Onboarding object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"Onboarding":{"type":"object","properties":{"onboardingId":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#/components/schemas/OnboardingStatusEnum"},"entityType":{"$ref":"#/components/schemas/OnboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of customer, proxy, beneficial owner or partner depending on the value of `entityType`"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["createdOn","entityId","entityType","modifiedOn","onboardingId","status"],"title":"Onboarding","description":""},"OnboardingStatusEnum":{"title":"OnboardingStatusEnum","type":"string","enum":["CREATED","PENDING","APPROVED","REJECTED","RECEIVED","INVALID"],"readOnly":true},"OnboardingEntityTypeEnum":{"title":"OnboardingEntityTypeEnum","type":"string","enum":["CUSTOMER","PROXY","BENEFICIAL_OWNER","PARTNER_USER"]}}}}
```

## The OffboardingUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"OffboardingUpdate":{"title":"OffboardingUpdate","type":"object","properties":{"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"}},"required":["reason"],"description":""},"OffboardingReasonEnum":{"title":"OffboardingReasonEnum","type":"string","enum":["CUSTOMER_REQUEST_IMMEDIATE","CANCELLATION_BY_PARTNER_ORDINARY","CANCELLATION_BY_PARTNER_IMMEDIATE","DEATH_IMMEDIATE","DISSOLUTION_IMMEDIATE","INSOLVENCY_IMMEDIATE","COMPANY_STRUCTURE_CHANGES_IMMEDIATE"]}}}}
```

## The Offboarding object

```json
{"openapi":"3.0.1","info":{"title":"Onboardings","version":"1.0"},"components":{"schemas":{"Offboarding":{"type":"object","properties":{"offboardingId":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#/components/schemas/OffboardingStatusEnum"},"entityType":{"$ref":"#/components/schemas/OffboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of customer, proxy or beneficial owner depending on the value of `entityType`"},"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["createdOn","entityId","entityType","modifiedOn","offboardingId","reason","status"],"title":"Offboarding","description":""},"OffboardingStatusEnum":{"title":"OffboardingStatusEnum","type":"string","enum":["RECEIVED","CREATED","PENDING","INVALID","REJECTED","CANCELED","APPROVED"],"readOnly":true},"OffboardingEntityTypeEnum":{"title":"OffboardingEntityTypeEnum","type":"string","enum":["CUSTOMER","PROXY","BENEFICIAL_OWNER"]},"OffboardingReasonEnum":{"title":"OffboardingReasonEnum","type":"string","enum":["CUSTOMER_REQUEST_IMMEDIATE","CANCELLATION_BY_PARTNER_ORDINARY","CANCELLATION_BY_PARTNER_IMMEDIATE","DEATH_IMMEDIATE","DISSOLUTION_IMMEDIATE","INSOLVENCY_IMMEDIATE","COMPANY_STRUCTURE_CHANGES_IMMEDIATE"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.wawex.ai/api-reference/onboardings/schemas.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.