Create verification exception

POST

https://api.sureshake.com/v2/directory/listings/{listingId}/verification-exceptions

Path parameters

listingId
string
required
format: uuid

Request body JSON required

dimension
identity
or
affiliation
required
requestReason
string
required
maxLength: 5000 · minLength: 20
evidenceReferences
array of
string
required
maxLength: 2000 · minLength: 1
requestedExpiresAt
string
required
format: date-time
organizationId
optional
string
format: uuid
affiliationRole
optional
string
maxLength: 255 · minLength: 1
affiliationTitle
optional
string
maxLength: 255 · minLength: 1

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- listingId
  string
  required
  format: uuid
- subjectUserId
  string
  required
- dimension
  identity
  or
  affiliation
  required
- organizationId
  string
  or null
  required
  format: uuid
- organizationName
  string
  or null
  required
- organizationSlug
  string
  or null
  required
- organizationType
  investor
  or
  fund
  or null
  required
- affiliationRole
  string
  or null
  required
- affiliationTitle
  string
  or null
  required
- requestReason
  string
  required
- evidenceReferences
  array of
  string
  required
- requestedExpiresAt
  string
  required
  format: date-time
- status
  pending
  or
  approved
  or
  rejected
  or
  revoked
  required
- requestedByUserId
  string
  required
- reviewedByUserId
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- reviewReason
  string
  or null
  required
- expiresAt
  string
  or null
  required
  format: date-time
- revokedByUserId
  string
  or null
  required
- revokedAt
  string
  or null
  required
  format: date-time
- revocationReason
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create verification exception

curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/listings/<listingId>/verification-exceptions' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dimension": "identity",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "affiliationRole": "string",
  "affiliationTitle": "string",
  "requestReason": "stringstringstringst",
  "evidenceReferences": [
    "string"
  ],
  "requestedExpiresAt": "2019-08-24T14:15:22Z"
}
'

const url = 'https://api.sureshake.com/v2/directory/listings/<listingId>/verification-exceptions';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    dimension: 'identity',
    organizationId: '7bc05553-4b68-44e8-b7bc-37be63c6d9e9',
    affiliationRole: 'string',
    affiliationTitle: 'string',
    requestReason: 'stringstringstringst',
    evidenceReferences: ['string'],
    requestedExpiresAt: '2019-08-24T14:15:22Z'
  })
};

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

import requests

url = "https://api.sureshake.com/v2/directory/listings/<listingId>/verification-exceptions"

payload = {
    "dimension": "identity",
    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
    "affiliationRole": "string",
    "affiliationTitle": "string",
    "requestReason": "stringstringstringst",
    "evidenceReferences": ["string"],
    "requestedExpiresAt": "2019-08-24T14:15:22Z"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
    "subjectUserId": "string",
    "dimension": "identity",
    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
    "organizationName": "string",
    "organizationSlug": "string",
    "organizationType": "investor",
    "affiliationRole": "string",
    "affiliationTitle": "string",
    "requestReason": "string",
    "evidenceReferences": [
      "string"
    ],
    "requestedExpiresAt": "2019-08-24T14:15:22Z",
    "status": "pending",
    "requestedByUserId": "string",
    "reviewedByUserId": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "reviewReason": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "revokedByUserId": "string",
    "revokedAt": "2019-08-24T14:15:22Z",
    "revocationReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

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

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

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

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

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

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

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

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