NCCPA API – Frequently Asked Questions (FAQs)

General


What types of APIs does NCCPA offer?

NCCPA provides secure, programmatic access to PA board certification status data and supports third-party submission of Category 1 CME activities on a PA’s behalf, enabling approved partners to integrate NCCPA services into their systems and workflows.

Who can use the NCCPA API?

Access is limited to approved users, typically state licensing boards, employers, and credentialing verification organizations.

What types of data are available through the API?

Available data depends on the NCCPA API you are authorized to use. The API Documentation site outlines the available endpoints for each API.

Is there a fee to use NCCPA APIs?

API access and any associated fees are determined by NCCPA agreements. Please refer to each license agreement on the NCCPA API Homepage to view the fees.


Access & Authentication


How do I request access to the API?

To request access, click on the Sign Up link, complete the form, and submit it. Please allow five business days for us to review your request.

How does authentication work?

The API uses secure authentication, such as an OAuth 2.0 token or code, to ensure only approved and authorized users and systems can access our data. HTTPS is required for all API calls.

Can I share my API credentials?

No. API credentials are unique to your organization and must be kept confidential. Sharing credentials may result in access being revoked.

What should I do if my credentials are compromised?

Immediately notify NCCPA so credentials can be reset or reissued, if necessary.


Technical Details


What format does the API use?

The NCCPA API uses standard RESTful conventions and returns responses in JSON format. Requests use standard HTTP methods.

What HTTP methods are supported?

NCCPA APIs support common HTTP methods such as GET and POST. The methods allowed depend on the specific endpoint. Refer to the API Documentation for more information.

Is there API documentation available?

Yes. Detailed technical documentation, including endpoint descriptions, request/response examples, and error codes, is available at API Documentation.

How are errors handled?

The API returns standard HTTP status codes along with descriptive error messages in the responses to help with diagnosing of issues.


Support & Maintenance


What are the API support hours?

API Support is available Monday through Friday, from 8:30 a.m. to 5:00 p.m. Eastern Time, excluding NCCPA holidays.

Requests received outside normal support hours will be reviewed on the next business day.

How do I get technical support?

For technical questions or issues, contact apisupport@nccpa.net.

Please include your organization's name, the affected environment, the date and time of the issue, and any relevant error messages. Do not include passwords, access tokens, or other sensitive information.

What technical support is included?

NCCPA provides support at no additional charge for general API issues determined to be NCCPA’s responsibility.

Assistance with implementation, testing, configuration, or troubleshooting in the sandbox or production environment may be billed against the support hours included in your organization’s agreement. Included hours and any additional fees may vary by agreement.

For additional details, visit the API Support and Service Availability page

When is the NCCPA API available?

The NCCPA API is intended to be available 24 hours a day, seven days a week, except during planned maintenance or service interruptions.

What is the API availability target?

NCCPA aims to keep the API available 99% of the time, with only rare, brief interruptions.

Will the API change over time?

Yes. The API may be updated to add features, improve performance, or address security requirements. NCCPA will provide notice of these changes, if applicable.

Is there a sandbox or test environment?

A sandbox environment will be provided to support development and testing prior to production use.

How will planned maintenance be communicated?

NCCPA will provide advance notice of planned maintenance when reasonably possible. Notices may be sent to designated API contacts or posted on the API website.



What are acceptable uses of the API?

The API may only be used for approved business purposes as outlined in your agreement with NCCPA.

What happens if I violate the API terms?

Violations may result in suspended or revoked access, and potentially further actions as outlined in NCCPA’s Terms of Use.

Who do I contact with non-technical questions?

Please contact NCCPA at api@nccpa.net for all non-technical questions.