Create listing claim request

POST

https://api.sureshake.com/v2/directory/listings/{listingId}/claim-requests

Path parameters

listingId
string
required
format: uuid

Request body JSON required

evidence
required
Any of the following:
object
method
authenticated_email_domain
required
object
method
entity_evidence
required
evidenceUrls
array of
string
required
format: uri
notes
string
required
maxLength: 5000 · minLength: 20
object
method
operator_review
required
notes
string
required
maxLength: 5000 · minLength: 20
object
method
manual_evidence
required
evidenceUrls
array of
string
required
format: uri · default: []
notes
string
required
maxLength: 5000 · minLength: 20
}

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- listingId
  string
  required
  format: uuid
- subjectType
  person
  or
  entity
  required
- requestedByUserId
  string
  required
- evidence
  object
  required
  method
  authenticated_email_domain
  or
  entity_evidence
  or
  operator_review
  or
  manual_evidence
  required
  verificationStatus
  verified
  or
  pending
  required
  authenticatedEmailDomain
  string
  or null
  required
  subjectDomain
  string
  or null
  required
  evidenceUrls
  array of
  string
  required
  format: uri
  notes
  string
  or null
  required
- status
  pending
  or
  approved
  or
  rejected
  or
  cancelled
  required
- reviewedByUserId
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- reviewNotes
  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 listing claim request

curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/listings/<listingId>/claim-requests' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evidence": {
    "method": "authenticated_email_domain"
  }
}
'

const url = 'https://api.sureshake.com/v2/directory/listings/<listingId>/claim-requests';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({evidence: {method: 'authenticated_email_domain'}})
};

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>/claim-requests"

payload = { "evidence": { "method": "authenticated_email_domain" } }
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",
    "subjectType": "person",
    "requestedByUserId": "string",
    "evidence": {
      "method": "authenticated_email_domain",
      "verificationStatus": "verified",
      "authenticatedEmailDomain": "string",
      "subjectDomain": "string",
      "evidenceUrls": [
        "http://example.com"
      ],
      "notes": "string"
    },
    "status": "pending",
    "reviewedByUserId": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "reviewNotes": "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"
  }
}