Update an onboard individual entity job

Request

Updates an onboard individual entity job.

Security

oauth2_client_credentials or oauth2_authorization_code

Path

entitystringrequired

The entity id.

onboardIndividualEntityJobstringrequired

The onboardIndividualEntityJob id.

Query

updateMaskstring

Optional. The list of fields to update. If omitted, or set to the special value *, the supplied job fully replaces the stored one.

Bodyapplication/json

Required. The job to update. The job's name field identifies the job to update.

namestring(name)

(IDENTIFIER) Output only. The resource name of the job. Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job} string.resource_name = ["entities/-/onboardIndividualEntityJobs/*"] // value must be a valid resource name

formDefinitionstring(form_definition)

(OPTIONAL) Optional. The resource name of the form definition to use for data collection. If unset, onboarding skips data capture and creates an empty individual entity named "New individual", carrying only the caller-supplied annotations; jsonata_expression must then also be unset. Format: formDefinitions/{form_definition} string.resource_name = ["formDefinitions/*"] // value must be a valid resource name

jsonataExpressionstring, (byte), non-empty(jsonata_expression)

(OPTIONAL) Required if (and only if) form_definition is set; must be unset otherwise. JSONata expression to transform form response into IndividualEntity. This must be base64-encoded when sent in JSON requests.

webhookUristring, (uri), <= 2048 characters(webhook_uri)required

Required. HTTPS webhook target URI for notifications. string.prefix = "https://"

enrichEntityboolean(enrich_entity)

(OPTIONAL) Optional. If true, entity will be enriched by verification response. Ignored when individual_entity_verification_job is set, in which case that job's own enrich_entity applies.

individualEntityVerificationJobstring(individual_entity_verification_job)

(OPTIONAL) Optional. The resource name of the individual entity verification job that drives the verification step of this onboarding, including its provider configuration and enrich_entity. When unset, verification runs Truuth AUS_CHECK. Format: individualEntityVerificationJobs/{individual_entity_verification_job} string.resource_name = ["individualEntityVerificationJobs/*"] // value must be a valid resource name

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "entities/-/onboardIndividualEntityJobs/mfs-onboard-job-2024-0127-kycind-743891",
    "formDefinition": "formDefinitions/mfs-individual-kyc-form-v2-1",
    "jsonataExpression": "{\n  \"legal_name\": {\n    \"given_name\": $$.form_data.personal_info.first_name,\n    \"family_name\": $$.form_data.personal_info.last_name\n  },\n  \"date_of_birth\": $$.form_data.personal_info.dob,\n  \"addresses\": [{\n    \"type\": \"RESIDENTIAL\",\n    \"street_address\": $$.form_data.address.street,\n    \"city\": $$.form_data.address.city,\n    \"postal_code\": $$.form_data.address.zip\n  }],\n  \"tax_identification\": {\n    \"tax_id_number\": $$.form_data.tax_info.ssn,\n    \"tax_id_type\": \"US_SSN\"\n  }\n}",
    "webhookUri": "https://api.example.com/webhooks/onboarding/individual/entity-job-status",
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z",
    "enrichEntity": true,
    "individualEntityVerificationJob": "individualEntityVerificationJobs/mfs-connectid-kyc-v1"
  }'

Responses

Success