Metadata Properties Reference

The metadata properties endpoint provides a comprehensive reference of all available data fields and check identifiers used in the Otentica verification system.

Endpoint

GET https://api.otentica.nl/check-metadata/properties
Accept: application/json

info

This endpoint is publicly accessible and does not require authentication. It returns the complete schema of available properties that can be returned by various verification checks.

Response Structure

The endpoint returns a JSON object containing property definitions organized by check type. Each property includes:

• Property name: The field identifier used in API responses
• Data type: The type of data (STRING, LIST, FILE, DATE, etc.)
• Check context: Which verification check produces this property
• Validation source: The third-party service or method used for verification

Property Categories

1. Healthcare Professional Data

Properties related to healthcare professional registrations in the Netherlands:

Property	Type	Description	Check Identifier
bigRegistrations	LIST	BIG registry registrations	big-data
bigProfessionalGroup	STRING	Professional category (e.g., Arts, Tandarts)	big-data
bigNumber	STRING	BIG registration number	big-data
bigSpecialisms	LIST	Medical specializations	big-data
bigLimitations	LIST	Professional practice limitations	big-data
bigJudgments	LIST	Disciplinary judgments	big-data
bigVisions	LIST	Professional competencies	big-data
skjRegistrations	LIST	SKJ registry registrations	skj-data
skjProfessionalGroup	STRING	Youth care professional category	skj-data
skjNumber	STRING	SKJ registration number	skj-data

2. Identity Data

Personal identification information verified through various sources:

Property	Type	Description	Check Identifier
firstName	STRING	First name	identity-data
lastName	STRING	Last name	identity-data
lastNamePrefix	STRING	Surname prefix (e.g., "van", "de")	identity-data
initials	STRING	Name initials	identity-data
dateOfBirth	DATE	Date of birth	identity-data
gender	STRING	Gender (MALE/FEMALE/OTHER)	identity-data
personalNumber	STRING	BSN (Dutch citizen service number)	identity-document-v2

3. Address Data

Residential and correspondence address information:

Property	Type	Description	Check Identifier
street	STRING	Street name	identity-data
houseNumber	STRING	House number	identity-data
houseNumberSuffix	STRING	House number addition	identity-data
postalCode	STRING	Postal code	identity-data
city	STRING	City	identity-data
countryCode	STRING	ISO country code	identity-data

4. Contact Information

Communication details:

Property	Type	Description	Check Identifier
email	STRING	Email address	correspondence-data
phone	STRING	Phone number	correspondence-data
websiteUrl	STRING	Website URL	correspondence-data
linkedinUrl	STRING	LinkedIn profile URL	correspondence-data

websiteUrl and linkedinUrl are collected only when enabled via the collectWebsiteUrl / collectLinkedInUrl configuration flags on the correspondence-data check. Both fields support an explicit "I don't have this" state: when a candidate opts out, the value is null and this is recorded as a deliberate response, not missing data.

URLs must be fully qualified (e.g. https://www.example.com). LinkedIn URLs are validated to point to linkedin.com.

5. Identity Document Data

Information from identity verification documents:

Property	Type	Description	Check Identifier
identityDocument	FILE	Front of ID document	identity-document-v2
identityDocumentBackside	FILE	Back of ID document	identity-document-v2
selfie	FILE	Selfie photo for verification	identity-document-v2
identityDocumentType	STRING	Type (PASSPORT/ID_CARD)	identity-document-v2
identityDocumentNumber	STRING	Document number	identity-document-v2
identityDocumentDateOfExpiry	DATE	Expiry date	identity-document-v2
nationality	STRING	Nationality (ISO code)	identity-document-v2

6. Company Data

Business and employer information:

Property	Type	Description	Check Identifier
companyName	STRING	Company name	company-data
kvkNumber	STRING	KvK (Chamber of Commerce) number	company-data
companyAddresses	LIST	Company addresses	company-data
companyRsin	STRING	RSIN of the company	company-data
companyLegalForm	STRING	Legal form of the company	company-data
sbiDescriptions	LIST	List of the SBI codes including descriptions	company-data
sbiCodes	LIST	List of the SBI codes without the descriptions	company-data

7. Bank Account Data

Financial account verification:

Property	Type	Description	Check Identifier
personalIban	STRING	Personal IBAN	bank-data
personalIbanName	STRING	Personal account holder name	bank-data
personalIbanCountry	STRING	Personal account country	bank-data
businessIban	STRING	Business IBAN	bank-data
businessIbanName	STRING	Business account holder name	bank-data
businessIbanCountry	STRING	Business account country	bank-data

Business account enforcement

When the bank-data check is configured with checkBusinessAccount: true and the candidate submits a personal IBAN, the API returns the remark business-personal-iban-not-allowed in the response. This remark is returned at the API level and is also reflected in the PDF report and the Otentica dashboard.

8. Credit Check Data

Credit assessment returned as part of the company-data check when enableCreditCheck: true is configured. Data is sourced from an external data provider; no provider name is returned in the API response.

Availability

These fields are only returned when company-data is configured with checkLevel: "EXTENDED" or checkLevel: "FULL" and enableCreditCheck: true.

Property	Type	Description	Check Identifier
creditCheckResult	STRING	Current credit rating label (e.g. A, B, C, or NOT_RATED)	company-data
creditCheckDescription	STRING	Human-readable description of the current rating	company-data
creditLimitCurrency	STRING	ISO 4217 currency code for the credit limit	company-data
creditLimitValue	STRING	Credit limit amount	company-data
creditScore	STRING	Numeric credit score	company-data
creditScoreDescription	STRING	Description of the credit score	company-data
creditPod	STRING	Probability of default	company-data
creditRatingChangeDate	STRING	Date of the most recent rating change	company-data
creditPreviousResult	STRING	Previous credit rating label	company-data
creditPreviousDescription	STRING	Human-readable description of the previous rating	company-data
creditPreviousLimitCurrency	STRING	ISO 4217 currency code for the previous credit limit	company-data
creditPreviousLimitValue	STRING	Previous credit limit amount	company-data
creditPreviousProviderDescription	STRING	Provider description for the previous rating period	company-data

When no credit rating is available for a company, creditCheckResult returns NOT_RATED. In this case creditLimitValue, creditScore, and creditPod may be null.

10. Education & Diploma Data

Educational qualifications and certifications:

Property	Type	Description	Check Identifier
diplomas	LIST	List of diploma objects	diploma-data
unverifiedDiplomas	LIST	Uploaded certificates	unverified-diploma-data

Each diploma object contains:

• type: Type of qualification (DIPLOMA/CERTIFICATE)
• title: Diploma title
• description: Detailed description
• issuer: Issuing institution
• level: Education level
• validFrom: Start date (if applicable)
• validUntil: Expiry date (if applicable)
• verifiedOn: Verification timestamp
• verifier: Verification source (e.g., "duo", "emrex")
• verificationStatus: Status of verification
• fileId: Associated document file ID

11. Integrity Data

Background and integrity check information:

Property	Type	Description	Check Identifier
vogDocument	FILE	VOG (Certificate of Good Conduct)	vog-data
vogDocumentDate	DATE	VOG issue date	vog-data
vogDocumentNumber	STRING	VOG document number	vog-data
vogScreeningProfile	STRING	VOG screening profile	vog-data

12. Employment References

Reference check data:

Property	Type	Description	Check Identifier
references	LIST	List of reference objects	reference-data

Each reference contains:

• referenceName: Reference person name
• referenceEmail: Reference contact email
• referenceCompany: Reference company
• referenceRelation: Relationship to candidate
• referenceResponse: Reference feedback

13. PEP Check Data

Result fields from the pep-check. Data is sourced from an external data provider; no provider name is returned in the API response.

Property	Type	Values / Description	Check Identifier
pepCheckResult	STRING	PEP / NOT_PEP / UNCERTAIN	pep-check
pepCheckScore	NUMERIC	Match score: 0.0 (no match) to 1.0 (full match)	pep-check
pepCheckSource	STRING	Audit — identifier of the external data source	pep-check
pepCheckDate	STRING	Audit — date on which the check was performed	pep-check

Scores at or above the configured threshold (default: 0.7) trigger a manual review flag. The threshold is configuration-driven per client.

14. Sanctions Check Data

Result fields from the sanctions-check. Data is sourced from an external data provider; no provider name is returned in the API response.

Property	Type	Values / Description	Check Identifier
sanctionsCheckResult	STRING	SANCTIONED / NOT_SANCTIONED / UNCERTAIN	sanctions-check
sanctionsCheckScore	NUMERIC	Match score: 0.0 (no match) to 1.0 (full match)	sanctions-check
sanctionsCheckSource	STRING	Audit — identifier of the external data source	sanctions-check
sanctionsCheckDate	STRING	Audit — date on which the check was performed	sanctions-check

Scores at or above the configured threshold (default: 0.7) trigger a manual review flag. The threshold is configuration-driven per client.

Data Types

The API uses the following data types for properties:

Type	Description	Example
STRING	Text value	"John Doe"
LIST	Array of values or objects	["value1", "value2"]
FILE	File reference UUID	"e7e5e957-f010-4de7-9423-fe7581965192"
DATE	ISO 8601 date format	"2024-01-15" or "2024-01-15T10:30:00Z"

Usage Example

// Fetch available properties
async function getMetadataProperties() {
  const response = await fetch(
    'https://api.otentica.nl/check-metadata/properties',
    {
      headers: {
        'Accept': 'application/json'
      }
    }
  );
  
  const properties = await response.json();
  return properties;
}

// Map properties to check results
function mapCheckResultToProperties(checkResult, properties) {
  const mappedData = {};
  
  checkResult.results.forEach(result => {
    // Use the property metadata to understand the data type
    const propertyMeta = properties[result.fieldName];
    
    if (propertyMeta) {
      mappedData[result.fieldName] = {
        value: result.value,
        type: propertyMeta.type,
        verified: result.verified,
        verifiedBy: result.verifiedBy,
        verifiedOn: result.verifiedOn
      };
    }
  });
  
  return mappedData;
}

Important Notes

Version Notice

The metadata properties endpoint is largely up-to-date but may not reflect the absolute latest additions. Always test with actual API responses to confirm available fields.

Best Practices

• Use this endpoint to understand available fields before implementing your integration
• Cache the response locally as the schema doesn't change frequently
• Not all properties will be present in every verification flow - availability depends on:
  • Selected check types in the flow configuration
  • User-provided data
  • Third-party service availability
  • Verification success

Related Documentation

• Creating a Flow - Configure which checks to include
• Tracking Progress - Retrieve verification results
• Webhooks - Get notified when data becomes available