Parameter glossary

Fourthline V2 APIs

Some parameters may look similar and can easily be confused. This glossary highlights the most commonly used parameters in Fourthline setups, and explains exactly what each one means.

ParameterDescription
branch Use this parameter for case configuration in older setups. Set the string provided by your Fourthline delivery manager. If not set, your default configuration will be used.
  • Setup: Legacy APIs
client_idThis identifier is part of your Fourthline API credentials.
  • Setup: PI v2, Legacy APIs
clientIdUnique identifier for the client, returned in your first Create workflow.
  • Setup: API v2, Legacy APIs
client_secretYour unique password from your Fourthline API credentials.
  • Setup: Legacy APIs
clientDataThe client’s identity data.
  • Setup: Legacy APIs
contactDetailsThe contact information of the client, including email address, phone number, and mobile number.
  • Setup: API v2
emailAndPhoneThe client’s email address and phone number(s).
  • Setup: API v2
identityDataContains the client’s identity details, including personal, address, contact, tax, and device metadata.
  • Setup: API v2
partnerClientIdYour unique identifier for the client. Once assigned, use the same partnerClientId for that client (natural person) across all workflows. Reusing the same identifier helps prevent duplicate client records.
  • Setup: API v2
providerClientId Your unique identifier for the client.
  • Setup: Legacy APIs
personThe client’s personal data.
  • Setup: Legacy APIs
personalDataThe client’s personal data.
  • Setup: API v2
providerProcessIdYour unique identifier for the case.
  • Setup: API v2
verificationId The unique identifier for the Identity Verification case.
  • Setup: Legacy APIs
workflowIdOur unique identifier for the workflow, returned in the Create workflow response.
  • Setup: Legacy APIs, API v2
workflowName of the workflow type you want to create.
  • Setup: API v2
workflowNameThe type of workflow.
  • Setup: Legacy APIs