Skip to content

NVSEP Voluntary Exclusion API (1.0)

The Voluntary Exclusion API provides information on self-exclusions.

Download OpenAPI description
Languages
Servers

https://portal.dev.nvsep.org/

Voluntary Exclusions

Operations

List voluntary exclusions

Request

Security
authorization
Query
paginationobject
filterobject
curl -i -X GET \
  'https://portal.dev.nvsep.org/api/v1/voluntary_exclusions?after=string&before=string&limit=0&submittedSince=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

Bodyapplication/json
dataArray of objects(VoluntaryExclusion)

Collection of voluntary exclusions

Example: [{"id":"f411a80b-dddb-4edc-b968-68a9ba41e987","propertySelections":[{"durationMonths":12,"id":"59ae7552-44ed-4009-92c3-9ff93c11f5a6","property":{"id":"d2a24d1d-880c-49e3-b967-19aed134896e","name":"Property 1"}}],"startDate":"2025-01-01","submittedAt":"2025-01-01T12:00:00Z","user":{"address":{"city":"Anytown","line1":"123 Main St","line2":null,"postalCode":"12345","state":"CA"},"dob":"1990-01-01","email":"john.doe@example.com","firstName":"John","id":"e418c0c8-c418-49cd-8e0a-35b6e05be8f0","lastName":"Doe","middleName":null,"name":"John Doe","phoneNumber":"+1234567890","preferredName":"John"},"userPhotos":[{"contentType":"image/jpeg","id":"72e35b2f-cb02-40a9-a09e-7f315c0ef905","kind":"face_and_id","path":"https://example.com/photo.jpg"}]}]
metaobject(PaginationMetadata)
Response
application/json
{ "data": [ {} ], "meta": { "after": "string", "before": "string", "limit": 0, "totalCount": 0 } }