API Reference
/
CFS Exclusions

NVSEP (1.0)

Download OpenAPI description
index.json
index.yaml
Overview
URL https://nvsep.org
NVSEP hello@nvsep.org
 Terms of Service
Languages
Servers
Mock server
https://developers.nvsep.org/_mock/apis/
https://portal.nvsep.org/api/

CFS Exclusions

Operations

List exclusions

Request

Query
paginationobject
filterobject
curl -i -X GET \
  'https://developers.nvsep.org/_mock/apis/api/cfs/v1/exclusions?after=string&before=string&hideOwn=true&limit=0&sinceId=string&totalCount=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Group response

Bodyapplication/json
dataArray of objects(CfsExclusion)

Collection of exclusions

Example: [{"createdAt":"2023-01-01T12:00:00Z","createdByOrg":{"id":"473bd688-ad6b-42dc-bbe8-8342537483cc","name":"IdPair, Inc."},"endDate":"2023-12-31","id":"e0df5fa5-72b9-4061-b1fd-b0bc82209a41","player":{"hashes":[{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]},"reference":"REF123","startDate":"2023-01-01"}]
metaobject(PaginationMetadata)
Response
application/json
{
  "entries": [
    { … }
  ],
  "meta": {
    "after": "eyJpZCI6MjAsImdyb3VwX2lkIjoxMCwicmVhc29uIjoiUG9saWN5IFZpb2xhdGlvbiJ9",
    "before": null,
    "limit": 25,
    "totalCount": 1
  }
}

Create exclusion

Request

Bodyapplication/json

CfsExclusionCreateInput

endDatestring

End date for the exclusion

Example: "2025-12-31"
playerobjectrequired

Player

Example: {"hashes":[{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]}
player.​hashesArray of objects

Collection of hashes

Example: [{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]
referencestring

External reference for the exclusion

Example: "EXC-0001"
startDatestringrequired

Start date for the exclusion

Example: "2025-01-01"
curl -i -X POST \
  https://developers.nvsep.org/_mock/apis/api/cfs/v1/exclusions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "endDate": "2025-12-31",
    "player": {
      "hashes": [
        {
          "createdAt": "2024-01-01T10:00:00Z",
          "hash1": "hash_value_1",
          "hash2": "hash_value_2",
          "hash3": "hash_value_3"
        }
      ]
    },
    "reference": "EXC-0001",
    "startDate": "2025-01-01"
  }'

Responses

CfsExclusion

Bodyapplication/json
createdAtstring(date-time)required

Timestamp of when the exclusion was created

Example: "2023-01-01T12:00:00Z"
createdByOrgobjectrequired
Example: {"id":"473bd688-ad6b-42dc-bbe8-8342537483cc","name":"IdPair, Inc."}
createdByOrg.​idstring

ID

Example: "473bd688-ad6b-42dc-bbe8-8342537483cc"
createdByOrg.​namestring

Name

Example: "IdPair, Inc."
endDatestring

End date for the exclusion

Example: "2023-12-31"
idstringrequired

Unique identifier for the CFS exclusion

Example: "e0df5fa5-72b9-4061-b1fd-b0bc82209a41"
playerobjectrequired

Player

Example: {"hashes":[{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]}
player.​hashesArray of objects

Collection of hashes

Example: [{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]
referencestring

Internal reference for the exclusion

Example: "REF123"
startDatestringrequired

Start date for the exclusion

Example: "2023-01-01"
Response
application/json
{
  "createdAt": "2023-01-01T12:00:00Z",
  "createdByOrg": {
    "id": "473bd688-ad6b-42dc-bbe8-8342537483cc",
    "name": "IdPair, Inc."
  },
  "endDate": "2023-12-31",
  "id": "e0df5fa5-72b9-4061-b1fd-b0bc82209a41",
  "player": {
    "hashes": [ … ]
  },
  "reference": "REF123",
  "startDate": "2023-01-01"
}

Check player exclusion status

Request

Bodyapplication/json

CfsInquiryCreateInput

playerobjectrequired
Example: {"hashes":[{"hash1":"97f1b7e9-58c5-4239-9436-760b8a2845de","hash2":"3308fde1-e712-4bad-8fa5-1a9ef0cdd0e9","hash3":"9587671e-3a6e-439c-bf13-faa9ca148059"}]}
player.​hashesArray of objectsrequired

Collection of hashes

Example: [{"hash1":"97f1b7e9-58c5-4239-9436-760b8a2845de","hash2":"3308fde1-e712-4bad-8fa5-1a9ef0cdd0e9","hash3":"9587671e-3a6e-439c-bf13-faa9ca148059"}]
player.​hashes[].​hash1stringrequired

Player Hash 1

player.​hashes[].​hash2stringrequired

Player Hash 2

player.​hashes[].​hash3stringrequired

Player Hash 3

curl -i -X POST \
  https://developers.nvsep.org/_mock/apis/api/cfs/v1/inquiries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "player": {
      "hashes": [
        {
          "hash1": "97f1b7e9-58c5-4239-9436-760b8a2845de",
          "hash2": "3308fde1-e712-4bad-8fa5-1a9ef0cdd0e9",
          "hash3": "9587671e-3a6e-439c-bf13-faa9ca148059"
        }
      ]
    }
  }'

Responses

CfsInquiry

Bodyapplication/json
exclusionStatusstringrequired

Status indicating whether an exclusion is active or not

Enum"NO_EXCLUSION_ACTIVE""EXCLUSION_ACTIVE"
Example: "NO_EXCLUSION_ACTIVE"
exclusionsArray of objects(CfsExclusion)required

Collection of exclusions

Example: []
exclusions[].​createdAtstring(date-time)required

Timestamp of when the exclusion was created

Example: "2023-01-01T12:00:00Z"
exclusions[].​createdByOrgobjectrequired
Example: {"id":"473bd688-ad6b-42dc-bbe8-8342537483cc","name":"IdPair, Inc."}
exclusions[].​createdByOrg.​idstring

ID

Example: "473bd688-ad6b-42dc-bbe8-8342537483cc"
exclusions[].​createdByOrg.​namestring

Name

Example: "IdPair, Inc."
exclusions[].​endDatestring

End date for the exclusion

Example: "2023-12-31"
exclusions[].​idstringrequired

Unique identifier for the CFS exclusion

Example: "e0df5fa5-72b9-4061-b1fd-b0bc82209a41"
exclusions[].​playerobjectrequired

Player

Example: {"hashes":[{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]}
exclusions[].​player.​hashesArray of objects

Collection of hashes

Example: [{"createdAt":"2024-01-01T10:00:00Z","hash1":"hash_value_1","hash2":"hash_value_2","hash3":"hash_value_3"}]
exclusions[].​referencestring

Internal reference for the exclusion

Example: "REF123"
exclusions[].​startDatestringrequired

Start date for the exclusion

Example: "2023-01-01"
idstringrequired

Unique identifier for the CFS inquiry

Example: "e0df5fa5-72b9-4061-b1fd-b0bc82209a41"
Response
application/json
{
  "exclusionStatus": "NO_EXCLUSION_ACTIVE",
  "exclusions": [],
  "id": "e0df5fa5-72b9-4061-b1fd-b0bc82209a41"
}