Enqueue a private info scan.

As scans complete, we will send a callback to your configured endpoint. For a realtime scan, we will send several event-triggered callbacks containing deltas. Otherwise, the system will wait until the scan completes to trigger a callback.

Use this endpoint to trigger removal of an existing scan's PII.

Enroll a customer in ongoing private info removal.

If there is already an active enrollment with the same customerId, you will receive an HTTP 409 response.

Note: the above uniqueness check is done using "eventual consistency", so two requests in quick succession with the same customerId value could potentially result in a duplicate.

Enrolling a customer will automatically trigger an immediate realtime scan, as well as non-realtime scans on a regular basis. As scans complete, we will send a callback to your configured endpoint. For a realtime scan, we will send several event-triggered callbacks containing deltas. Otherwise, the system will wait for the scan to complete before sending a callback.

As we verify the removal of private info records, we will also post a records callback with the updated record information.

If a callback fails, we will retry with exponential back-off until it succeeds.

Performs a shallow update of the enrollment object.

For example, if you want to update any part of the profile attribute, you must pass the entire profile object.

Cancel an enrollment.

Use this endpoint to trigger removal of an existing enrollment's PII.

WARNING: This may result in orphaned records that can no longer be remediated.

The Cancel Enrollment endpoint is preferred, as it will only delete this information once all records have been remediated.

Use this endpoint to add an authentication token for a third-party service to a customer.

The token parameter should be the entire JSON token received from the service's OAuth flow. For example, for gmail, the token would look something like this:

{
  "access_token":"ya29...0163",
  "refresh_token":"1//0...erfU",
  "scope":"https://www.googleapis.com/auth/gmail.readonly openid https://www.googleapis.com/auth/userinfo.email",
  "token_type":"Bearer",
  "id_token":"eyJh...lzNg",
  "expiry_date":1664403894958
}

Use this endpoint to invalidate all third-party authentication tokens for a customer

Use this endpoint to set the authorized signature data for a customer

Use this endpoint to revoke the authorized signature for a customer

Tracks a customer interaction on the client website.

Retrieve the current manifest of public keys that can validate callback POSTs from the Privacy API. They are expressed in JWKS (JSON Web Key Set) format that should be easily loadable into a number of JWT/JWK implementations for the purposes of validation. Since the manifest changes very rarely, you can safely cache the manifest for performance and only re-fetch if you find you are missing a key ID.

Privacy API callbacks will include a X-Webhook-JWS signature that is a payload-decoupled JSON Web Token (JWT) signed with the private side of the presented public keys. By validating the POST body against this token, you will confirm that not only did the callback originate from the Privacy API, but also that the contents have not been manipulated as changes to the data would invalidate the signature. Inside the "header" section of the token is a kid property which matches up with one of the keys in the manifest.

The steps required to validate a callback are as follows:

• Encode the received POST body as "URI-safe" Base64 and replace it into the token provided in the header so the token reads: <JWT Header>.<Payload>.<Signature>. Most languages should have a library to do this encoding, such as url-safe-base64 for Node.js or this helper function for PHP.

Effectively the algorithm is:

1) Perform a standard Base64 "encode" on the string.
2) Replace all "+" characters with "-"
3) Replace all "/" characters with "_"
4) Trim any "=" padding characters at the end

• Use your JWT implementation to decode/parse the JWT so you can access the decoded header. This will reveal the ID of the key you need to authenticate against. Some implementations, such as jose for Node.js or php-jwt for PHP allow you to simply provide the entire key set.
• Use your JWK/JWKS implementation to verify the token against the appropriate key (or key set if supported by your JWT implementation) from the manifest.
• If the verification fails, you cannot be certain the callback contents are genuine.
• If the kid value in the header is not one of the keys in the manifest, try re-fetching the manifest and attempting your verification loop again. The Privacy API will not start signing callbacks using a key until its public counterpart is available via this endpoint in Production.

Get the status of a scan.

Get all records matched by a specific scan.

Get all Broker Scans associated with a specific scan.

Get the status of a customer.

Get all scans belonging to a specific customer

Get all Enrollments belonging to a specific customer

Get the status of an enrollment.

Get scans belonging to an enrollment

Get the list of data brokers for all plans associated with your client.

Get a specific broker by the broker's ID

Get a list of scan IDs from failed callback requests.

If a scan callback request fails to yield a success response, we will retry submitting the request over a period of time. If requests continue to fail after a configurable threshold, they will be logged as failures and future attempts will be halted. You will be notified via email that a failure has occurred. You may then use this endpoint to retrieve the scan IDs from the failed callbacks.

This endpoint is intended to be used to recover lost data after a system or network failure. Rate limits will not allow you to rely solely on this endpoint for polling scan updates.

The number and duration of retries vary by environment and can be provided on request.

Get a list of enrollment IDs from failed callback requests.

If an enrollment callback request fails to yield a success response, we will retry submitting the request over a period of time. If requests continue to fail after a configurable threshold, they will be logged as failures and future attempts will be halted. You will be notified via email that a failure has occurred. You may then use this endpoint to retrieve the enrollment IDs from the failed callbacks.

This endpoint is intended to be used to recover lost data after a system or network failure. Rate limits will not allow you to rely solely on this endpoint for polling scan updates.

The number and duration of retries vary by environment and can be provided on request.

If you encounter missing data, a scan or removal that was not submitted when expected, or a scan that failed, you can notify us programmatically using this endpoint.

Certain exceptionType values imply the inclusion of specific id fields. These are "soft" requirements - meaning that the endpoint will still accept your POST without the ids, but we may not be able to act on the report without additional information.

• failedBrokerScan requires brokerScanIds
• missingBrokerScans, missingRecurringRecords, and missingFreeScanRecords require scanIds
• removalsNotSubmitted and removalsNotVerified require recordIds
• missingFreeScanId requires customerIds
• missingRecurringScan requires enrollmentIds

Get the full list of subscription plans assigned to an API client account. Subscription plans allow API clients to define multiple configuration sets for enrollments. Each subscription plan defines the following settings:

• The list of brokers to be scanned for an enrollment.
• The scan settings used for scoring and matching records.
• The rescan cadence of an enrollment. (How often we run rescans)
• The billing cycle for enrollments created under the plan.

Get a single subscription plan. Subscription plans allow API clients to define multiple configuration sets for enrollments. Each subscription plan defines the following settings:

• The list of brokers to be scanned for an enrollment.
• The scan settings used for scoring and matching records.
• The rescan cadence of an enrollment. (How often we run rescans)
• The billing cycle for enrollments created under the plan.

Get the full list of broker families. A broker family will only include brokers ids that are active for the client's plans.