List KYB Extracted Parties API

Python

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.list_kyb_extracted_parties(
    "33333333-4444-5555-6666-777777777777",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.sessions.listKybExtractedParties("33333333-4444-5555-6666-777777777777");
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.ListKYBExtractedParties(ctx, "33333333-4444-5555-6666-777777777777", didit.SessionsListKYBExtractedPartiesParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.sessions().listKybExtractedParties("33333333-4444-5555-6666-777777777777");
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->sessions->listKybExtractedParties('33333333-4444-5555-6666-777777777777');
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.ListKybExtractedPartiesAsync("33333333-4444-5555-6666-777777777777");
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "parties": [
    {
      "name": "Ana Lopez",
      "entity_type": "person",
      "first_name": "Ana",
      "last_name": "Lopez",
      "appointment_date": null,
      "designation": "Administrador unico",
      "roles": [
        {
          "role": "shareholder",
          "ownership_percent": {
            "text": "60%",
            "min": 60,
            "max": 60
          }
        }
      ],
      "documents": [
        {
          "document_uuid": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41",
          "document_type": "OWNERSHIP_STRUCTURE",
          "document_subtype": "ARTICLES_OF_INCORPORATION",
          "original_filename": "acta_constitutiva.pdf",
          "status": "Approved"
        }
      ]
    }
  ],
  "document_count": 1,
  "node_id": "node_kyb_documents"
}

GET

session

{sessionId}

kyb

extracted-parties

Python

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.list_kyb_extracted_parties(
    "33333333-4444-5555-6666-777777777777",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.sessions.listKybExtractedParties("33333333-4444-5555-6666-777777777777");
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.ListKYBExtractedParties(ctx, "33333333-4444-5555-6666-777777777777", didit.SessionsListKYBExtractedPartiesParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.sessions().listKybExtractedParties("33333333-4444-5555-6666-777777777777");
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->sessions->listKybExtractedParties('33333333-4444-5555-6666-777777777777');
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.ListKybExtractedPartiesAsync("33333333-4444-5555-6666-777777777777");
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "parties": [
    {
      "name": "Ana Lopez",
      "entity_type": "person",
      "first_name": "Ana",
      "last_name": "Lopez",
      "appointment_date": null,
      "designation": "Administrador unico",
      "roles": [
        {
          "role": "shareholder",
          "ownership_percent": {
            "text": "60%",
            "min": 60,
            "max": 60
          }
        }
      ],
      "documents": [
        {
          "document_uuid": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41",
          "document_type": "OWNERSHIP_STRUCTURE",
          "document_subtype": "ARTICLES_OF_INCORPORATION",
          "original_filename": "acta_constitutiva.pdf",
          "status": "Approved"
        }
      ]
    }
  ],
  "document_count": 1,
  "node_id": "node_kyb_documents"
}

Authorizations

x-api-key

string

header

required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

sessionId

string<uuid>

required

UUID of the Business Verification (KYB) session. It must belong to the application of the API key.

Example:

"33333333-4444-5555-6666-777777777777"

Query Parameters

node_id

string

Workflow node of the KYB step. Only needed when the workflow has more than one KYB node; by default Didit uses the session's own node.

Response

Parties named by the current documents.

parties

object[]

required

The shareholders and directors the uploaded documents name, merged per person. Nobody is labelled a UBO here: that is decided when the parties are submitted.

Show child attributes

document_count

integer

required

Number of uploaded documents the list was read from.

node_id

string | null