Create CoworkerIdentityCheckDocument

POST

api

spaces

coworkeridentitycheckdocuments

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "CoworkerIdentityCheckId": 123,
  "Name": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments"

payload = {
    "CoworkerId": 123,
    "CoworkerIdentityCheckId": 123,
    "Name": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerId: 123, CoworkerIdentityCheckId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

ID check evidence holds the files submitted for a customer’s identity or address check; its submission status contributes to the parent check’s verification lifecycle.

Authentication

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 CoworkerIdentityCheckDocument-Create role.

Enums

eIdVerificationStatus — VerificationStatus values

Value	Name
1	Pending
2	Submitted
3	Successful
4	Failed
5	Cancelled

Request Body

Required Fields

integer

required

ID of the customer whose ID check evidence this is..

integer

required

ID of the parent customer ID check; it determines which evidence files are required and owns the document status..

string

required

Required operator-facing label for this ID check evidence record..

Optional Fields

string

URL of a new file to upload as the photo.

boolean

Set to true to remove the current photo file.

string

URL of a new file to upload as the document.

boolean

Set to true to remove the current document file.

string

URL of a new file to upload as the additional document.

boolean

Set to true to remove the current additional document file.

string

Optional free-text reviewer notes about this ID check evidence..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "CoworkerIdentityCheckId": 0,
    "Name": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      CoworkerIdentityCheckId: 0,
      Name: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'CoworkerIdentityCheckId': 0,
        'Name': ''
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkeridentitycheckdocument was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerIdentityCheckDocument was successfully created.",
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create CoworkerIdentityCheckDocument

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "CoworkerIdentityCheckId": 123,
  "Name": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments"

payload = {
    "CoworkerId": 123,
    "CoworkerIdentityCheckId": 123,
    "Name": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerId: 123, CoworkerIdentityCheckId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/coworkeridentitycheckdocuments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create CoworkerIdentityCheckDocument

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400