---
title: "Submit correction"
---

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

Path: Sureshake API › directory

`POST /v2/directory/{subjectType}/{listingId}/corrections`

## Path parameters

- `subjectType` (`directory-submit-correction.path.subjectType`; string, required)
  - one of `"person"`, `"entity"`
- `listingId` (`directory-submit-correction.path.listingId`; string, required)
  - format `uuid`

## Request body

_Required._

- `kind` (`directory-submit-correction.kind`; string, required)
  - one of `"field_correction"`, `"duplicate_report"`
- `proposedCanonicalListingId` (`directory-submit-correction.proposedCanonicalListingId`; string, optional)
  - format `uuid`
- `field` (`directory-submit-correction.field`; string, optional)
  - minLength 1; maxLength 255
- `proposedValue` (`directory-submit-correction.proposedValue`; string, optional)
  - minLength 1; maxLength 2000
- `note` (`directory-submit-correction.note`; string, optional)
  - minLength 1; maxLength 2000
- `evidenceUrl` (`directory-submit-correction.evidenceUrl`; string, optional)
  - format `uri`; maxLength 2000

## Example request

```json
{
  "kind": "field_correction",
  "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
  "field": "string",
  "proposedValue": "string",
  "note": "string",
  "evidenceUrl": "http://example.com"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/person/<listingId>/corrections' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "field_correction",
  "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
  "field": "string",
  "proposedValue": "string",
  "note": "string",
  "evidenceUrl": "http://example.com"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/directory/person/<listingId>/corrections';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'field_correction',
    proposedCanonicalListingId: '25e80c76-032c-4937-8352-5b6509442364',
    field: 'string',
    proposedValue: 'string',
    note: 'string',
    evidenceUrl: 'http://example.com'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/directory/person/<listingId>/corrections"

payload = {
    "kind": "field_correction",
    "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
    "field": "string",
    "proposedValue": "string",
    "note": "string",
    "evidenceUrl": "http://example.com"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 201

Default Response

#### Example

```json
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
    "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
    "subjectType": "person",
    "kind": "field_correction",
    "field": "string",
    "proposedValue": "string",
    "note": "string",
    "evidenceUrl": "string",
    "submittedByUserId": "string",
    "status": "pending",
    "disputeVisible": true,
    "reviewedByUserId": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "resolutionNote": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`directory-submit-correction.response.201.data`; object, required)
  - `id` (`directory-submit-correction.response.201.data.id`; string, required)
    - format `uuid`
  - `listingId` (`directory-submit-correction.response.201.data.listingId`; string, required)
    - format `uuid`
  - `proposedCanonicalListingId` (`directory-submit-correction.response.201.data.proposedCanonicalListingId`; string, required, nullable)
    - format `uuid`
  - `subjectType` (`directory-submit-correction.response.201.data.subjectType`; string, required)
    - one of `"person"`, `"entity"`
  - `kind` (`directory-submit-correction.response.201.data.kind`; string, required)
    - one of `"field_correction"`, `"duplicate_report"`
  - `field` (`directory-submit-correction.response.201.data.field`; string, required, nullable)
  - `proposedValue` (`directory-submit-correction.response.201.data.proposedValue`; string, required, nullable)
  - `note` (`directory-submit-correction.response.201.data.note`; string, required, nullable)
  - `evidenceUrl` (`directory-submit-correction.response.201.data.evidenceUrl`; string, required, nullable)
  - `submittedByUserId` (`directory-submit-correction.response.201.data.submittedByUserId`; string, required)
  - `status` (`directory-submit-correction.response.201.data.status`; string, required)
    - one of `"pending"`, `"accepted"`, `"rejected"`, `"dismissed"`
  - `disputeVisible` (`directory-submit-correction.response.201.data.disputeVisible`; boolean, required)
  - `reviewedByUserId` (`directory-submit-correction.response.201.data.reviewedByUserId`; string, required, nullable)
  - `reviewedAt` (`directory-submit-correction.response.201.data.reviewedAt`; string, required, nullable)
    - format `date-time`
  - `resolutionNote` (`directory-submit-correction.response.201.data.resolutionNote`; string, required, nullable)
  - `createdAt` (`directory-submit-correction.response.201.data.createdAt`; string, required)
    - format `date-time`
  - `updatedAt` (`directory-submit-correction.response.201.data.updatedAt`; string, required)
    - format `date-time`
- `meta` (`directory-submit-correction.response.201.meta`; object, optional)
  - `timestamp` (`directory-submit-correction.response.201.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.400.error`; object, required)
  - `code` (`directory-submit-correction.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.401.error`; object, required)
  - `code` (`directory-submit-correction.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.403.error`; object, required)
  - `code` (`directory-submit-correction.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.404.error`; object, required)
  - `code` (`directory-submit-correction.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.409.error`; object, required)
  - `code` (`directory-submit-correction.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.429.error`; object, required)
  - `code` (`directory-submit-correction.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.500.error`; object, required)
  - `code` (`directory-submit-correction.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-submit-correction.response.503.error`; object, required)
  - `code` (`directory-submit-correction.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-submit-correction.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-submit-correction.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-submit-correction.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-submit-correction/index.md