> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt
> Use this file to discover all available pages before exploring further.

# Registration Status

> Check whether a subject is registered in the didx:verify system.

## Overview

This endpoint checks the registration status of a subject within the didx:verify system.

## Endpoint

```
POST /Citizen/GetRegistrationStatus
```

## Request

```bash theme={null}
curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/GetRegistrationStatus" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "IdNumber": "8001014800080",
    "CRef": "REF00001"
  }'
```

### Request Fields

| Field             | Type    | Required | Description                |
| ----------------- | ------- | -------- | -------------------------- |
| `ConsentReceived` | boolean | **Yes**  | Must be `true`             |
| `IdNumber`        | string  | **Yes**  | SA ID number to check      |
| `CRef`            | string  | No       | Your transaction reference |

## Response

```json theme={null}
{
  "IsRegistered": true,
  "RegistrationDate": "2024-01-15T08:30:00Z",
  "Status": "Success",
  "CRef": "REF00001"
}
```

| Field              | Description                                                   |
| ------------------ | ------------------------------------------------------------- |
| `IsRegistered`     | `true` if the subject has a registration record in the system |
| `RegistrationDate` | Date the subject was registered                               |