> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update CoworkerIdentityCheck

> Update an existing CoworkerIdentityCheck record.

Updates an existing CoworkerIdentityCheck record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`CoworkerIdentityCheck-Edit`** role.
</Note>

## Enums

<Accordion title="eIdentityCheckProvider — IdentityCheckProvider values">
  | Value | Name           |
  | ----- | -------------- |
  | 0     | None           |
  | 1     | Manual         |
  | 2     | StripeIdentity |
</Accordion>

<Accordion title="eIdentityCheckDocumentType — IdentityDocumentType values">
  | Value | Name                        |
  | ----- | --------------------------- |
  | 0     | None                        |
  | 1     | Passport                    |
  | 2     | DriversLicense              |
  | 3     | IdCard                      |
  | 4     | UniformedServiceId          |
  | 5     | CertificateOfNaturalization |
  | 6     | AccessCard                  |
  | 7     | MatriculaConsular           |
  | 8     | ResidentCard                |
  | 9     | UniversityId                |
  | 10    | NEXUSCard                   |
  | 99    | Other                       |
</Accordion>

<Accordion title="eAddressCheckDocumentType — AddressDocumentType values">
  | Value | Name                    |
  | ----- | ----------------------- |
  | 0     | None                    |
  | 1     | Passport                |
  | 2     | DriversLicense          |
  | 3     | IdCard                  |
  | 4     | LeaseRentalAgreement    |
  | 5     | InsurancePolicy         |
  | 6     | Mortgage                |
  | 7     | VehicleRegistrationCard |
  | 8     | VoterCard               |
  | 99    | Other                   |
</Accordion>

<Accordion title="eIdVerificationType — VerificationType values">
  | Value | Name       |
  | ----- | ---------- |
  | 0     | None       |
  | 1     | IdDocument |
  | 2     | Address    |
</Accordion>

<Accordion title="eIdVerificationStatus — VerificationStatus values">
  | Value | Name       |
  | ----- | ---------- |
  | 0     | None       |
  | 1     | Pending    |
  | 2     | Submitted  |
  | 3     | Successful |
  | 4     | Failed     |
  | 5     | Cancelled  |
</Accordion>

## Request Body

### Required Fields

<ParamField body="Id" type="integer" required>
  The Id of the CoworkerIdentityCheck record to update.
</ParamField>

<ParamField body="BusinessId" type="integer" required>
  Business Id.
</ParamField>

<ParamField body="CoworkerId" type="integer" required>
  Coworker Id.
</ParamField>

<ParamField body="Name" type="string" required>
  Display name for this verification check.
</ParamField>

<ParamField body="IdentityCheckProvider" type="integer" required>
  How the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated).
</ParamField>

<ParamField body="IdentityDocumentType" type="integer" required>
  Type of identity document used when VerificationType is IdDocument.
</ParamField>

<ParamField body="AddressDocumentType" type="integer" required>
  Type of address document used when VerificationType is Address.
</ParamField>

### Optional Fields

<ParamField body="IdentityDocumentNumber" type="string">
  Number or identifier on the identity document.
</ParamField>

<ParamField body="IdentityDocumentIssuedBy" type="string">
  Authority or organisation that issued the identity document.
</ParamField>

<ParamField body="IdentityDocumentExpirationDate" type="string">
  Expiration date of the identity document.
</ParamField>

<ParamField body="Description" type="string">
  Free-text notes or details about this check.
</ParamField>

<ParamField body="Billed" type="boolean">
  Billed.
</ParamField>

<ParamField body="StripeVerificationSessionId" type="string">
  Stripe Verification Session Id.
</ParamField>

<ParamField body="IdentityCheckProvider1" type="integer">
  Identity Check Provider1. See `eIdentityCheckProvider?` enum above.
</ParamField>

<ParamField body="VerificationType1" type="integer">
  Verification Type1. See `eIdVerificationType?` enum above.
</ParamField>

<ParamField body="Description1" type="string">
  Description1.
</ParamField>

<ParamField body="IdentityCheckProvider2" type="integer">
  Identity Check Provider2. See `eIdentityCheckProvider?` enum above.
</ParamField>

<ParamField body="VerificationType2" type="integer">
  Verification Type2. See `eIdVerificationType?` enum above.
</ParamField>

<ParamField body="Description2" type="string">
  Description2.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/spaces/coworkeridentitychecks" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "CoworkerId": 0,
      "Name": "",
      "IdentityCheckProvider": 0,
      "IdentityDocumentType": 0,
      "AddressDocumentType": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        CoworkerId: 0,
        Name: '',
        IdentityCheckProvider: 0,
        IdentityDocumentType: 0,
        AddressDocumentType: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'CoworkerId': 0,
          'Name': '',
          'IdentityCheckProvider': 0,
          'IdentityDocumentType': 0,
          'AddressDocumentType': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkeridentitycheck was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerIdentityCheck was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 400

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```