The PII class to apply to the field. Valid values are aba_routing_number, credit_card, crypto, email_address, ip_address, sg_nric_fin, us_bank_number, us_driver_license, us_itin, us_tax_id, us_passport, phone_number, us_ssn, advertising_id, esndec_id, esnhex_id, imei, mac_address, meid, password, person_name, first_name, middle_name, last_name, full_name, us_address, us_address_full, age, gender, city, coordinate, nationality, partial_coordinate, date, birth_date, death_date, time, us_state, us_zipcode, domain_name, generic_did, generic_continuous, generic_category. A value of 'None' is allowed and will be treated neither as a DID or QID.

The treatment method to apply to the field. Valid values are hide, lock, hash, mask, fake, anonymize.

A dictionary of field names, with a dictionary of treatment methods and pii classes. pii_class is required. treatment_method is optional.

If unspecified, the project's default_job_run_type value is used. If the project's default_job_run_type is 'load_assess' and the project does not have a destination connection set, the project default cannot be overridden. k_target, k_strategy, and field_config can only be specified if the job run type used is 'load_treat_write'

Deprecated: use job_run_type='load_write'

Required unless default_job_run_type is 'load_assess'

Required if default_job_run_type is 'load_treat_write'

The endpoint URL of the S3 backend service. Only required for S3-compatible services like GCS

The SSH port of the SSH host to connect to

The SSH private key to use. This can be a stringified RSA key or a filepath

Hostname of the URL, without any scheme, port, or path component. E.g., 'www.example.com'

The path component of the URL, without any query or fragment parameters. E.g., '/api/v1/resource'

The port of the URL, as a string-formatted number. If the default 443 port is used, the string can be left empty. E.g., '8443'

This API uses OAuth 2 with the clients grant flow.

Privacy API

did_suppression_method

exclude_untreated

Table processed successfully, returned with DIDs suppressed

connection_id

Used to queue a single job or all jobs within a project.

Delete webhook specification (i.e. all webhook call URIs) for a given organization


Get webhook specification (i.e. all webhook call URIs) for a given organization

Create or Update webhooks for a given organization

Webhook verification failed, because the provided webhook is invalid, or points to a private IP address

expand

include_job_statuses

project_id

Updates an existing project, except for its connections or default_job_run_type (currently).

Job Definitions

The job definition model

Properties

Get job definitions for a given project_id

Request

Response

Create a new job definition

Request

Response

Create a batch of job definitions on the parent project

Request

Response

Update a job definitions for a given project_id

Request

Response

Delete a job definitions for a given project_id

Request

Response