> ## 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.
# Get one CoworkerIdentityCheck
> Retrieve a single CoworkerIdentityCheck record by its Id.
A **CoworkerIdentityCheck** represents a manual or Stripe Identity-based verification of a customer's identity or address. Each check is linked to a `Coworker` and a `Business` (location).
The `VerificationType` determines the nature of the check:
| VerificationType | Purpose |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| IdDocument (1) | Verifies the customer's identity using an official document (passport, driver's license, ID card, etc.) |
| Address (2) | Verifies the customer's address using a supporting document (lease agreement, insurance policy, voter card, etc.) |
When `VerificationType` is `IdDocument`, use `IdentityDocumentType` to specify the document kind, along with `IdentityDocumentNumber`, `IdentityDocumentIssuedBy`, and `IdentityDocumentExpirationDate`. When `VerificationType` is `Address`, use `AddressDocumentType` instead.
`IdentityCheckProvider` controls how the check is performed: `Manual` (1) means the operator reviews documents directly, while `StripeIdentity` (2) delegates verification to Stripe Identity.
The `VerificationStatus` tracks progress through the check lifecycle: `Pending` → `Submitted` → `Successful` or `Failed` (or `Cancelled`).
## 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 **`CoworkerIdentityCheck-Read`** role.
## Path Parameters
The Id of the CoworkerIdentityCheck record to retrieve.
## Code Examples
```bash cURL theme={null}
curl -X GET \
"https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/87654321" \
-H "Authorization: Bearer YOUR_TOKEN"
```
```javascript JavaScript theme={null}
const response = await fetch(
'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/87654321',
{
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
}
);
const record = await response.json();
```
```python Python theme={null}
import requests
response = requests.get(
'https://spaces.nexudus.com/api/spaces/coworkeridentitychecks/87654321',
headers={
'Authorization': 'Bearer YOUR_TOKEN'
}
)
record = response.json()
```
## Response
### 200
Business Id.
Name of the location (business) this check belongs to.
Coworker Id.
Full name of the customer being verified.
Type of the customer (e.g. Member, TeamMember).
Company name of the customer being verified.
Billing name of the customer being verified.
Display name for this verification check.
How the check is performed: Manual (operator review) or StripeIdentity (Stripe-delegated). See `eIdentityCheckProvider` enum values: `0` = None, `1` = Manual, `2` = StripeIdentity.
Type of identity document used when VerificationType is IdDocument. See `eIdentityCheckDocumentType` enum values: `0` = None, `1` = Passport, `2` = DriversLicense, `3` = IdCard, `4` = UniformedServiceId, `5` = CertificateOfNaturalization, `6` = AccessCard, `7` = MatriculaConsular, `8` = ResidentCard, `9` = UniversityId, `10` = NEXUSCard, `99` = Other.
Number or identifier on the identity document.
Authority or organisation that issued the identity document.
Expiration date of the identity document.
Type of address document used when VerificationType is Address. See `eAddressCheckDocumentType` enum values: `0` = None, `1` = Passport, `2` = DriversLicense, `3` = IdCard, `4` = LeaseRentalAgreement, `5` = InsurancePolicy, `6` = Mortgage, `7` = VehicleRegistrationCard, `8` = VoterCard, `99` = Other.
Whether this check verifies the customer's identity (IdDocument) or address (Address). See `eIdVerificationType` enum values: `0` = None, `1` = IdDocument, `2` = Address.
Free-text notes or details about this check.
Current status of the verification (Pending, Submitted, Successful, Failed, or Cancelled). See `eIdVerificationStatus` enum values: `0` = None, `1` = Pending, `2` = Submitted, `3` = Successful, `4` = Failed, `5` = Cancelled.
Most recent error message if the check failed.
Billed.
Proposal Guid.
Coworker Contract Guid.
Contract Contact Guid.
Stripe Verification Session Id.
Identity Check Group Guid.
Identity Check Provider1.
Verification Type1.
Description1.
Identity Check Provider2.
Verification Type2.
Description2.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
```json Example Response theme={null}
{
"BusinessId": 0,
"BusinessName": null,
"CoworkerId": 0,
"CoworkerFullName": null,
"CoworkerCoworkerType": null,
"CoworkerCompanyName": null,
"CoworkerBillingName": null,
"Name": "",
"IdentityCheckProvider": 0,
"IdentityDocumentType": 0,
"IdentityDocumentNumber": null,
"IdentityDocumentIssuedBy": null,
"IdentityDocumentExpirationDate": null,
"AddressDocumentType": 0,
"VerificationType": 0,
"Description": null,
"VerificationStatus": 0,
"LastError": null,
"Billed": false,
"ProposalGuid": null,
"CoworkerContractGuid": null,
"ContractContactGuid": null,
"StripeVerificationSessionId": null,
"IdentityCheckGroupGuid": null,
"IdentityCheckProvider1": 0,
"VerificationType1": 0,
"Description1": null,
"IdentityCheckProvider2": 0,
"VerificationType2": 0,
"Description2": null,
"Id": 87654321,
"UpdatedOn": "2025-01-15T10:30:00Z",
"CreatedOn": "2025-01-10T08:00:00Z",
"UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"UpdatedBy": "admin@example.com",
"IsNew": false,
"SystemId": null,
"ToStringText": "CoworkerIdentityCheck Example",
"LocalizationDetails": null,
"CustomFields": null
}
```