Quick Start + Architecture

This document provides an overview of the NewRosetta CIDV (Customer Identity Verification) API and the Lexicon verification endpoints, explaining their roles in creating and validating identities and using a gradient model to analyze and verify them. Additionally, it includes a functional flow, a high-level integration guideline, and an optional step for webhooks and linking.

Functional Flow

1. Identity Creation:

   • Use NewRosetta’s CIDV Identity API to create and manage identity records.
   • Capture details such as name, address, document type, and document images.

2. Identity Validation:

   • Validate the identity using the CIDV Identity API.
   • Ensure compliance and authenticity of the provided information.

3. Verification with Lexicon AI:

   • Pass the validated identity to Lexicon AI’s verification endpoints.
   • Lexicon AI employs a complex gradient model to assess identity risk and provide a verification outcome (e.g., PASSED, FAILED, STEPPED_UP).

4. Optional Webhooks and Linking:

   • Set up webhooks to receive real-time updates on verification status.
   • Link multiple verification events to a single identity for comprehensive tracking.

Integration Guidelines

Step 1: Create an Identity

• Endpoint: POST /lexicon/v1/identities
• Action: Submit identity details (name, address, document images, etc.) using the CIDV Identity API.
• Key Parameters:
  • firstName, lastName, dob, citizenship, documentType, imageUrls
• Example:
  Bash

  curl -X POST "http://api.newrosetta.com/lexicon/v1/identities" \
  -H "x-api-key: <API_KEY>" \
  -H "x-client-id: <CLIENT_ID>" \
  -H "Content-Type: application/json" \
  -d '{ "firstName": "John", "lastName": "Doe", "citizenship": "US" }'

Step 2: Validate the Identity

• Endpoint: GET /lexicon/v1/identities/{id}
• Action: Fetch the created identity’s details and validate its authenticity.
• Key Steps:
  1. Review the returned identity data.
  2. Use the validated field to confirm if the identity is valid.

Step 3: Submit Identity for Lexicon Verification

• Endpoint: POST /lexicon/v1/verifications
• Action: Pass the validated identity to Lexicon AI for advanced risk assessment.
• Key Parameters:
  • identityId: The unique ID of the validated identity.
• Example:
  Bash

  curl -X POST "http://api.newrosetta.com/lexicon/v1/verifications" \
  -H "x-api-key: <API_KEY>" \
  -H "x-client-id: <CLIENT_ID>" \
  -H "Content-Type: application/json" \
  -d '{ "identityId": "123e4567-e89b-12d3-a456-426614174000" }'

Step 4: Process Verification Results

• Endpoint: GET /lexicon/v1/verifications/{id}
• Action: Fetch and process the verification result from Lexicon AI.
• Response:
  • Review the lexiconOutcome and lexiconScore fields for a risk-based decision.

Bonus Step: Use Webhooks for Real-Time Updates

• Endpoint: POST /lexicon/v1/webhooks
• Action: Register a webhook to receive updates when verification results are available.
• Example:
  Bash

  curl -X POST "http://api.newrosetta.com/lexicon/v1/webhooks" \
  -H "x-api-key: <API_KEY>" \
  -H "x-client-id: <CLIENT_ID>" \
  -H "Content-Type: application/json" \
  -d '{ "destinationUrl": "https://yourapp.com/webhook", "active": true }'

Bonus Step: Link Multiple Events to an Identity

• Action: Use the identityId field to link multiple verification events to a single identity, providing a unified tracking mechanism.

Diagram of Steps

+-------------------+          +-------------------+          +-------------------+          +-------------------+
|   Create Identity |   ---->  | Validate Identity |   ---->  | Lexicon AI Verify |   ---->  |  Process Results  |
+-------------------+          +-------------------+          +-------------------+          +-------------------+
         |                                  |                                 |                                  |
         V                                  V                                 V                                  V
   Use CIDV API                      Confirm Details               Advanced Gradient Model            Optional Webhooks

Recipes for Integration

Explore the Recipes tab for ready-made code samples and end-to-end integration workflows. These recipes allow you to:

• Develop integrations in multiple programming languages using code generation.
• Follow step-by-step guidelines for seamless implementation.

Note

If you have your own identity provider, NewRosetta can integrate its signals instead of using its built-in identity validation APIs. In this case, you would only use the Lexicon AI verification endpoints for risk assessment and validation.