PossibleNOW

Overview

Authorization

API Error Codes

List Management API

Retrieve Filters

Add Numbers

Remove Numbers

QuickCheck API

QuickCheck Settings

QuickCheck AuthProfile

Sample request:

    [
        {
            "PhoneNumber": "7702551020",
            "LastEBRDate": "02/01/2024",
            "LastRNDDate": "02/01/2024"
        },
        {
            "PhoneNumber": "7702551021",
            "LastEBRDate": "02/01/2024",
            "LastRNDDate": "02/01/2024"
        }  
    ] 
    
Sample response:

    {
        "SuccessCount": 2,
        "ErrorCount": 0,
        "QuickCheckResults": [
            {
                "CallCurfewWindow": {
                    "Start": "1000",
                    "End": "2000",
                    "WithinCallWindow": "YES"
        },
                "Filters": [
                    {
                        "FilterName": "GEORGIA 770",
                        "Flag": "NGA",
                        "IsWireless": false,
                        "ListDate": "2004-04-30T15:55:00",
                        "CustomerDate": "2004-04-30T15:55:00",
                        "CustomerName": ""
        }
                ],
                "PhoneNumber": "7702551020",
                "StateOfResidence": "",
                "LastEBRDate": "02/01/2024",
                "LastRNDDate": "02/01/2024",
                "Status": "DNC",
                "TimeZone": "1"
        },
        {
                "CallCurfewWindow": {
                    "Start": "1000",
                    "End": "2000",
                    "WithinCallWindow": "YES"
        },
                "Filters": [],
                "PhoneNumber": "7702551021",
                "StateOfResidence": "",
                "LastEBRDate": "02/01/2024",
                "LastRNDDate": "02/01/2024",
                "Status": "",
                "TimeZone": "1"
        }
        ]
    }

Check numbers using Area Code

Sample response:

    {
        "SuccessCount": 2,
        "ErrorCount": 0,
        "QuickCheckResults": [
            {
                "CallCurfewWindow": {
                    "Start": "1000",
                    "End": "2000",
                    "WithinCallWindow": "YES"
        },
                "Filters": [
                    {
                        "FilterName": "GEORGIA 770",
                        "Flag": "NGA",
                        "IsWireless": false,
                        "ListDate": "2004-04-30T15:55:00",
                        "CustomerDate": "2004-04-30T15:55:00",
                        "CustomerName": ""
        }
                ],
                "PhoneNumber": "7702551020",
                "StateOfResidence": "",
                "LastEBRDate": "02/01/2024",
                "LastRNDDate": "02/01/2024",
                "Status": "DNC",
                "TimeZone": "1"
        },
        {
                "CallCurfewWindow": {
                    "Start": "1000",
                    "End": "2000",
                    "WithinCallWindow": "YES"
        },
                "Filters": [],
                "PhoneNumber": "7702551021",
                "StateOfResidence": "",
                "LastEBRDate": "02/01/2024",
                "LastRNDDate": "02/01/2024",
                "Status": "",
                "TimeZone": "1"
        }
        ]
    }

Check numbers using SOR

CallCurfew API

Retrieve CallCurfew Information by NPA/NXX

Retrieve CallCurfew Information by SOR

Retrieve CallCurfew Information by SOR and Postal Code

Reporting API

Retrieve Reports

Retrieve Number Research Summary 

Retrieve Call List Upload History

Retrieve DNC List Summary

Retrieve List Refresh Summary

Retrieve Scrub Report

Retrieve Quickcheck Activity

Password Policy

Sample request:

    {
        "PasswordMinimumLength": 8,
        "PasswordMaximumLength": 20,
        "MaximumPasswordAge": 90,
        "PasswordHistory": 4,
        "MaxNumberOfLoginAttempts": 3,
        "LockoutDurationInSeconds": 300,
        "NumberOfRequiredUpperCaseCharacters": 1,
        "NumberOfRequiredLowerCaseCharacters": 1,
        "NumberOfRequiredNumericCharacters": 1,
        "NumberOfRequiredExtendedCharacters": 2,
        "CryptographyType": "SHA256"
    }

Add password policy

Retrieves the system wide default password policy

Sample response:

    {
        "Name": "Master",
        "PasswordMinimumLength": 6,
        "PasswordMaximumLength": 20,
        "MaximumPasswordAge": 60,
        "PasswordHistory": 3,
        "MaxNumberOfLoginAttempts": 3,
        "LockoutDurationInSeconds": 300,
        "NumberOfRequiredUpperCaseCharacters": 1,
        "NumberOfRequiredLowerCaseCharacters": 1,
        "NumberOfRequiredNumericCharacters": 1,
        "NumberOfRequiredExtendedCharacters": 1,
        "CryptographyType": "SHA256",
        "Edited": {
            "CreateDate": "08/31/2024"
        }
    }

Retrieve default password policy

Sample response:

    {
        "Name": "Customer Policy",
        "PasswordMinimumLength": 6,
        "PasswordMaximumLength": 20,
        "MaximumPasswordAge": 60,
        "PasswordHistory": 3,
        "MaxNumberOfLoginAttempts": 3,
        "LockoutDurationInSeconds": 300,
        "NumberOfRequiredUpperCaseCharacters": 1,
        "NumberOfRequiredLowerCaseCharacters": 1,
        "NumberOfRequiredNumericCharacters": 1,
        "NumberOfRequiredExtendedCharacters": 1,
        "CryptographyType": "SHA256",
        "Edited": {
            "CreateDate": "08/31/2024"
        }
    }

Retrieve password policy

DNC Policy Fulfillment

Retrieve DNC Policies

Retrieve Policy by PolicyLink

Retrieve Policy Requests by Agent

Send Policy

User API

Sample response:
            
    {
        "Id": 229932,
        "UserName": "03919900-a75c-4600-833f-244f99c54c48",
        "FirstName": "Some",
        "LastName": "User",
        "Email": "user@mail.com",
        "Phone": "7702551020",
        "PhoneExt": "321",
        "Role": "Manager",
        "QuickCheckAuthProfileOverride": "",
        "DoNotMailAccess": true,
        "QuickCheckAccess": true,
        "IsLocked": false,
        "IsActive": true,
        "LastLoginDate": "08/01/2024 4:24:07 PM",
        "PasswordModifiedDate": "",
        "Edited": {
          "CreateDate": "07/05/2017",
          "CreatedBy": "sysAdmin",
          "ModifiedDate": "02/15/2024",
          "ModifiedBy": "userManager"
        }
    }

Retrieve Users

Sample request:

    {
          "UserName": "NewUser0!",
          "FirstName": "New",
          "LastName": "User",
          "Email": "newuser@mail.com",
          "Phone": "7702551020",
          "PhoneExt": "001",
          "Role": "Manager",
          "QuickCheckAuthProfileOverride": "QC Access",
          "DoNotMailAccess": true,
          "QuickCheckAccess": true
    }

Sample response:
            
    {
        "Id": 230040,
        "SubmittedTime": "2024-10-29 10:13:15.859"
    }

Add User

Sample request:

    {
          "UserName": "NewUser0!",
          "FirstName": "New",
          "LastName": "User",
          "Email": "newuser@mail.com",
          "Phone": "7702551020",
          "PhoneExt": "001",
          "Role": "Manager",
          "QuickCheckAuthProfileOverride": "QC Access",
          "DoNotMailAccess": true,
          "QuickCheckAccess": true,
          "IsLocked": false,
          "IsActive": true
    }

Update User

Default

DNCSolution

client_id

client_secret

environment

scope

Production

Sandbox

<p class="slate-p " >The DNCSolution REST API Version 4 is designed to help organizations streamline their compliance processes,  enabling adherence to Do Not Contact (DNC) regulatory standards with efficiency and accuracy. Each category within the API library corresponds to a specific set of functionality area within the platform. Understanding these categories will help you simplify your integration strategy and automate key compliance use cases.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Specifications for all API endpoints can be accessed via the <a href="https://api.dncsolution.com/v4/swagger/v1/swagger.json" target="">Swagger file</a>.</p></div></div><h3 class="slate-h3 " ><strong class="slate-bold">List Management APIs</strong></h3><p class="slate-p " >Use these APIs to add or remove phone numbers from your calling lists.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Primary Use Cases</strong>: Add numbers, remove numbers</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Key Endpoints</strong>:</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/AddNumbers</code> – Add one or more numbers across Filters.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/RemoveNumbers</code> - Remove one or more numbers across Filters.</div></li></ul><h3 class="slate-h3 " ><strong class="slate-bold">QuickCheck APIs</strong></h3><p class="slate-p " >Use these APIs to check phone numbers against Do Not Contact registries such as National, State, and any internal Do Not Contact lists. It also accounts for call time restrictions, checks against the Reassigned Numbers Database (RND) and your Established Business Relationship (EBR) rules.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Primary Use Cases</strong>: Check phone numbers against DNC lists for compliance</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Key Endpoints</strong>:</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/QuickCheck/{AuthProfileId}</code> – Check phone numbers using the area code.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/QuickCheck/{AuthProfileId}/SOR</code>- Check phone numbers using the State of Residence.</div></li></ul><p class="slate-p " >QuickCheck APIs contain two sets of API endpoints: one for GET requests and the other for POST requests. Both sets are designed for data retrieval, with one using query parameters and the other accepting parameters in the request body.</p><h3 class="slate-h3 " >CallCurfew <strong class="slate-bold">APIs</strong></h3><p class="slate-p " >Use these APIs to retrieve information on call curfew to identify the prohibited call times.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Primary Use Cases</strong>: Retrieve call curfew information by Area Code, State of Residence (SOR), and NPA/NXX</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Key Endpoints</strong>:</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/CallCurfew/NPANXX/{NPA}/{NXX}</code> – Retrieves call curfew information by NPA/NXX.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/CallCurfew/{SOR}</code> - Retrieves call curfew information by State of Residence (SOR).</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">/{ClientId}/CallCurfew/{SOR}/{PostalCode}</code> - Retrieves call curfew information by State of Residence (SOR) and Postal Code.</div></li></ul><h3 class="slate-h3 " >Reporting <strong class="slate-bold">APIs</strong></h3><p class="slate-p " >API&apos;s designed to enable developers generate actionable insights from application usage and number scrubs. </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Track quick check activity for all agents.</div></li><li class="slate-li " ><div style="position:relative">Track specific phone numbers checked by one or more agents.</div></li><li class="slate-li " ><div style="position:relative">Generate list-specific tracking for phone numbers associated with scrubs.</div></li><li class="slate-li " ><div style="position:relative">Retrieve bulk scrubbing information for specific date ranges.</div></li><li class="slate-li " ><div style="position:relative">Retrieve last-updated information on Third-party Do Not Call lists including Federal, State, and Litigator Lists.</div></li></ul><h3 class="slate-h3 " >DNC Policy Fulfillment <strong class="slate-bold">APIs</strong></h3><p class="slate-p " >Use these APIs to retrieve, track, and send Internal Do Not Call Policy requests. </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Retrieve all Do Not Contact policies configured in your account</div></li><li class="slate-li " ><div style="position:relative">Retrieve policy requests for specific agents</div></li><li class="slate-li " ><div style="position:relative">Send policies to consumers upon request</div></li></ul><p class="slate-p " >Maintaining a written DNC policy and making a version of it available to consumers upon request is a key component to establishing Safe Harbor defense.</p><h3 class="slate-h3 " >User Management APIs</h3><p class="slate-p " >API&apos;s designed to handle operations related to creating, retrieving, and updating users within your DNCSolution account.</p><h3 class="slate-h3 " >Password Policy APIs</h3><p class="slate-p " >Use these APIs to define and apply custom password policies to your DNCSolution account.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Configure a custom password policy for your DNCSolution account.</div></li><li class="slate-li " ><div style="position:relative">Access the default password policy configured on your account.</div></li><li class="slate-li " ><div style="position:relative">Access the password policy currently applied to your account.</div></li></ul><p class="slate-p " ></p>

The DNCSolution REST API Version 4 is designed to help organizations streamline their compliance processes,  enabling adherence to Do Not Contact (DNC) regulatory standards with efficiency and accuracy. Each category within the API library corresponds to a specific set of functionality area within the platform. Understanding these categories will help you simplify your integration strategy and automate key compliance use cases.

Use these APIs to add or remove phone numbers from your calling lists.

Use these APIs to check phone numbers against Do Not Contact registries such as National, State, and any internal Do Not Contact lists. It also accounts for call time restrictions, checks against the Reassigned Numbers Database (RND) and your Established Business Relationship (EBR) rules.

QuickCheck APIs contain two sets of API endpoints: one for GET requests and the other for POST requests. Both sets are designed for data retrieval, with one using query parameters and the other accepting parameters in the request body.

Use these APIs to retrieve information on call curfew to identify the prohibited call times.

API's designed to enable developers generate actionable insights from application usage and number scrubs. 

Use these APIs to retrieve, track, and send Internal Do Not Call Policy requests. 

Maintaining a written DNC policy and making a version of it available to consumers upon request is a key component to establishing Safe Harbor defense.

API's designed to handle operations related to creating, retrieving, and updating users within your DNCSolution account.

Use these APIs to define and apply custom password policies to your DNCSolution account.

<p class="slate-p " >The List Management APIs allow you to manage your Do Not Contact lists. Using these API&apos;s, you can add and remove numbers from your lists, specify opt-status indicators such as Express Consent or Do Not Contact, capture date, and customer name. </p><p class="slate-p " >This API library contains just two endpoints, where each endpoint is focused on a single task, following the Single Responsibility Principle (SRP) in software design. One endpoint is for adding phone numbers to your Do Not Contact lists and the other endpoint is for removing numbers from those lists. </p>

The List Management APIs allow you to manage your Do Not Contact lists. Using these API's, you can add and remove numbers from your lists, specify opt-status indicators such as Express Consent or Do Not Contact, capture date, and customer name. 

This API library contains just two endpoints, where each endpoint is focused on a single task, following the Single Responsibility Principle (SRP) in software design. One endpoint is for adding phone numbers to your Do Not Contact lists and the other endpoint is for removing numbers from those lists. 

<p class="slate-p " >The QuickCheck API allows you to perform single and multiple phone number checks against your Do Not Contact lists. It accounts for stored Established Business Relationships (EBR), State of Emergency, Call Curfew,  and Reassigned Numbers Database (RND).</p><p class="slate-p " >The DNCSolution v4 REST API offers two QuickCheck endpoints for each method, GET and POST, one that supports State of Residence (SOR) and another that does not. This separation allows you to choose the endpoint that best fits your business needs, ensuring a more streamlined and efficient integration experience.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >The GET API&apos;s support up to 100 phone numbers per request, while the POST API&apos;s allow a maximum of 500 phone numbers per request. Exceeding this limit will result in an error.</p></div></div><p class="slate-p " >Before using the API, it is important to familiarize yourself with the <strong class="slate-bold">Scrub Type</strong> setting as outlined below.</p><h4 class="slate-h4 " >Scrub Type</h4><p class="slate-p " >With the implementation of State of Residence (SOR) as an alternative to exclusively relying on Area Code (AC), we have introduced a new setting called <em class="slate-italic">Scrub Type</em>. This setting offers three distinct values:</p><p class="slate-p slate-indent-1" style="24px"><strong class="slate-bold">Type 1 - Area Code (AC) Only:</strong> This is the <strong class="slate-bold">default setting </strong>which only uses the phone number’s Area Code (AC) to determine the state.</p><p class="slate-p slate-indent-1" style="24px"><strong class="slate-bold">Type 2 – State of Residence (SOR) Only:</strong> This setting uses the State of Residence (SOR) specified in the API request to determine the state associated with the phone number. It will completely ignore the area code of the phone number being checked.</p><p class="slate-p slate-indent-1" style="24px"><strong class="slate-bold">Type 3 – Area Code (AC) and State of Residence (SOR):</strong> This setting requires both the State of Residence (SOR) and Area Code (AC) of a phone number to produce the most conservative output.</p><p class="slate-p " ><strong class="slate-bold">Key Considerations:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">If the Scrub Type setting is configured as <strong class="slate-bold">Type 1</strong> on your account, calling the State of Residence (SOR) API endpoint <strong class="slate-bold">will result in an error</strong>. </div></li><li class="slate-li " ><div style="position:relative">If the <code class="slate-code">LastEBRDate </code>field is omitted, the current date <strong class="slate-bold">will not be used</strong> to check for an EBR.</div></li><li class="slate-li " ><div style="position:relative">The <code class="slate-code">WithinCallCurfewWindow </code>was identified as a redundant field and will no longer be returned as part of the Call Curfew response.</div></li><li class="slate-li " ><div style="position:relative">Mobile Scoring will no longer be included in the JSON response as it is being replaced by the Reassigned Numbers Database (RND) list. You can reach out to our Data Services division for initial status updates on lists utilizing mobile scoring.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Applicable only to GET APIs:</strong> Any optional parameters which are omitted must be represented with a comma. See the examples below.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example 1: A customer sending in only a phone number for the non-SOR version would send in PhoneDataList[n]=7778889999,</div></li><li class="slate-li " ><div style="position:relative">Example 2: A customer sending in an SOR list and omitting the postal code and EBR date would send in SORDataList[n]=7778889999,GA,,,08012024</div></li></ul><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >In the above examples, <code class="slate-code">n</code> is an index, starting from 0, that specifies the position of an element in the array.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The QuickCheck API allows you to perform single and multiple phone number checks against your Do Not Contact lists. It accounts for stored Established Business Relationships (EBR), State of Emergency, Call Curfew,  and Reassigned Numbers Database (RND).

The DNCSolution v4 REST API offers two QuickCheck endpoints for each method, GET and POST, one that supports State of Residence (SOR) and another that does not. This separation allows you to choose the endpoint that best fits your business needs, ensuring a more streamlined and efficient integration experience.

Before using the API, it is important to familiarize yourself with the 

With the implementation of State of Residence (SOR) as an alternative to exclusively relying on Area Code (AC), we have introduced a new setting called 

. This setting offers three distinct values:

which only uses the phone number’s Area Code (AC) to determine the state.

Type 2 – State of Residence (SOR) Only:

 This setting uses the State of Residence (SOR) specified in the API request to determine the state associated with the phone number. It will completely ignore the area code of the phone number being checked.

Type 3 – Area Code (AC) and State of Residence (SOR):

 This setting requires both the State of Residence (SOR) and Area Code (AC) of a phone number to produce the most conservative output.

 Any optional parameters which are omitted must be represented with a comma. See the examples below.

<p class="slate-p " >The CallCurfew API returns the calling time restrictions using a specific area code and exchange, state of residence, or a combination of state of residence and postal code. Calling time restrictions set specific hours when calls are allowed or prohibited as determined by the Telemarketing Sales Rule (TSR) enforced by the Federal Trade Commission (FTC) to respect individual privacy and business hours, ensuring communication happens at appropriate times. Permitted calling hours vary by state law.</p>

The CallCurfew API returns the calling time restrictions using a specific area code and exchange, state of residence, or a combination of state of residence and postal code. Calling time restrictions set specific hours when calls are allowed or prohibited as determined by the Telemarketing Sales Rule (TSR) enforced by the Federal Trade Commission (FTC) to respect individual privacy and business hours, ensuring communication happens at appropriate times. Permitted calling hours vary by state law.

<p class="slate-p " >The <strong class="slate-bold">Reporting API</strong> provides a comprehensive suite of endpoints to help users retrieve detailed historical data across various activities performed within the application. Whether you need to retrieve research summary for a phone number, examine your agents&apos; quick check activities, or access call list upload history for phone numbers, the Reporting API is ideal for users looking to perform audits, access upload history, and track agent queries and activity timelines. </p><h4 class="slate-h4 " ><strong class="slate-bold">Overview</strong></h4><p class="slate-p " >The <strong class="slate-bold">Number Research APIs</strong> search the historical database of all company-specific State, National, and Private Do Not Call lists and provide you with details pertaining to the specified phone number. They also allow you to search your company&apos;s call list processing activities to determine if the phone number appeared in any of your calling lists or was searched through Agent DNCQuickcheck or API calls.</p><p class="slate-p " >The <strong class="slate-bold">Call List API</strong> gives you the complete upload history of any file that was submitted through DNCSolution for a phone number.  If the scrub was performed through SFTP, CallList will always be specified as “Default CallList”.</p><p class="slate-p " >The <strong class="slate-bold">Login History API</strong> provides a 30-day log of all authorized users on your account who have logged in to DNCSolution, starting from the specified Start Date.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Reporting APIs can be only be accessed by users with Administrator and Manager roles.</p></div></div><p class="slate-p " ></p>

 provides a comprehensive suite of endpoints to help users retrieve detailed historical data across various activities performed within the application. Whether you need to retrieve research summary for a phone number, examine your agents' quick check activities, or access call list upload history for phone numbers, the Reporting API is ideal for users looking to perform audits, access upload history, and track agent queries and activity timelines. 

 search the historical database of all company-specific State, National, and Private Do Not Call lists and provide you with details pertaining to the specified phone number. They also allow you to search your company's call list processing activities to determine if the phone number appeared in any of your calling lists or was searched through Agent DNCQuickcheck or API calls.

 gives you the complete upload history of any file that was submitted through DNCSolution for a phone number.  If the scrub was performed through SFTP, CallList will always be specified as “Default CallList”.

 provides a 30-day log of all authorized users on your account who have logged in to DNCSolution, starting from the specified Start Date.

<p class="slate-p " >The Password Policy API enables you to define and apply custom password policies, retrieve the system-wide default policy, or access your currently configured policy. This ensures compliance with security standards while offering flexibility to tailor password requirements based on your organizational needs.</p><p class="slate-p " ></p>

The Password Policy API enables you to define and apply custom password policies, retrieve the system-wide default policy, or access your currently configured policy. This ensures compliance with security standards while offering flexibility to tailor password requirements based on your organizational needs.

<p class="slate-p " >The DNC Policy Fulfillment APIs enable you to retrieve, track, and send internal Do Not Call Policy disclosures to customers, ensuring transparency and adherence to Do Not Contact regulations.</p><p class="slate-p " >Here&apos;s an <a href="https://www.compliancepoint.com/marketing-compliance/do-you-need-a-do-not-call-policy/" target="">informative article</a> that highlights the importance of maintaining an active Do Not Contact Policy.</p><p class="slate-p " ></p>

The DNC Policy Fulfillment APIs enable you to retrieve, track, and send internal Do Not Call Policy disclosures to customers, ensuring transparency and adherence to Do Not Contact regulations.

 that highlights the importance of maintaining an active Do Not Contact Policy.

<p class="slate-p " >Retrieve all Do Not Contact policies associated with your account.</p>

Retrieve all Do Not Contact policies associated with your account.

This is your organization’s DNCSolution account Id.

ClientId

Collection of Do Not Contact policies associated with your account.

ClientPolicies

Alphanumeric identifier specifying the type of error encountered.

ErrorCode

Description providing additional details about the error.

ErrorDescription

The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence. 

<p class="slate-p " >Retrieve a specific Do Not Contact policy using the policy link.</p>

Retrieve a specific Do Not Contact policy using the policy link.

Unique identifier of the Do Not Contact policy.

DNCPolicyLink

Name

Department

Company

Address1

Address2

City

StateProvince

PostalCode

PhoneNumber

Document

Edited

Message

<p class="slate-p " >Retrieve policy requests processed by a specific agent.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >The <code class="slate-code">StartDate</code> and <code class="slate-code">EndDate</code> query parameters are required on this endpoint. The request will fail if they are missing or malformed. Supported date formats include:</p><p class="slate-p " >
<code class="slate-code">YYYY-MM-DD (e.g., 2025-02-20)</code>
<code class="slate-code">MMDDYYYY (e.g., 02202025)</code></p></div></div><p class="slate-p " ></p>

Retrieve policy requests processed by a specific agent.

AgentUserId

Defines the beginning of the date range for retrieving policy requests by agent. Policy requests created or updated on or after this date will be included.

StartDate

Defines the end of the date range for retrieving policy requests. Policy requests created or updated on or before this date will be included.

EndDate

The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

<p class="slate-p " >Queues a policy to be shipped to an individual upon request.</p>

Queues a policy to be shipped to an individual upon request.

Country

This is your organization's DNC Account Id.

DNCPolicyQueueLink

<p class="slate-p " >The User Management API provides a simple and scalable way to manage users in your DNCSolution account. With endpoints for creating, updating, and retrieving users, you can seamlessly integrate user management into your system while ensuring security and efficiency.</p>

The User Management API provides a simple and scalable way to manage users in your DNCSolution account. With endpoints for creating, updating, and retrieving users, you can seamlessly integrate user management into your system while ensuring security and efficiency.

Sections