---
title: "Get KYC sample data."
method: GET
path: "/kyc_sample"
tags: ["Off-chain"]
---

# Get KYC sample data.

`GET /kyc_sample`

This method can be used to test different behaviors during the off-chain KYC data exchange  process. The data is used by the counterparty wallet app to set up its test account’s KYC data.

## Response `200`

success

- KycSample — KYC data sample for clients to create accounts to do off-chain KYC data exchanging tests. 1. `minimum` property value should be minimum valid `KycDataObject` that can pass server's KYC evaluation without any additional actions during the off-chain KYC data exchange process. 2. `reject` property value should be an example of `KycDataObject` that will be rejected by server if it is presented in a counterparty service's KYC data. 3. `soft_match` property value should be an example of `KycDataObject` that will trigger `soft_match` process and pass KYC evaluation after `additional_kyc_data` is provided by counterparty service. 4. `soft_reject` provided value should be an example of `KycDataObject` that will trigger `soft_match` process and then be rejected by KYC evaluation after `additional_kyc_data` is provided.
  - `minimum` KycDataObject, required — A KycDataObject represents the know your customer or know your client (KYC) data required for exchanging KYC data in Diem off-chain API. It matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
    - `payload_version` string, required — Version identifier to allow modifications to KYC data Object without needing to bump version of entire API set. Set to 1
    - `type` 'individual' | 'entity', required
    - `given_name` string — Legal given name of the user for which this KYC data Object applies.
    - `surname` string — Legal surname of the user for which this KYC data Object applies.
    - `address` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `dob` string — Date of birth for the holder of this account. Specified as an ISO 8601 calendar date format: https://en.wikipedia.org/wiki/ISO_8601
    - `place_of_birth` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `national_id` NationalId — National ID information for the holder of this account
      - `id_value` string, required — Indicates the national ID value - for example, a social security number
      - `county` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `type` string — Indicates the type of the ID
    - `legal_entity_name` string — Name of the legal entity. Used when subaddress represents a legal entity rather than an individual. KycData should only include one of legal_entity_name OR given_name/surname
  - `reject` KycDataObject, required — A KycDataObject represents the know your customer or know your client (KYC) data required for exchanging KYC data in Diem off-chain API. It matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
    - `payload_version` string, required — Version identifier to allow modifications to KYC data Object without needing to bump version of entire API set. Set to 1
    - `type` 'individual' | 'entity', required
    - `given_name` string — Legal given name of the user for which this KYC data Object applies.
    - `surname` string — Legal surname of the user for which this KYC data Object applies.
    - `address` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `dob` string — Date of birth for the holder of this account. Specified as an ISO 8601 calendar date format: https://en.wikipedia.org/wiki/ISO_8601
    - `place_of_birth` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `national_id` NationalId — National ID information for the holder of this account
      - `id_value` string, required — Indicates the national ID value - for example, a social security number
      - `county` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `type` string — Indicates the type of the ID
    - `legal_entity_name` string — Name of the legal entity. Used when subaddress represents a legal entity rather than an individual. KycData should only include one of legal_entity_name OR given_name/surname
  - `soft_match` KycDataObject, required — A KycDataObject represents the know your customer or know your client (KYC) data required for exchanging KYC data in Diem off-chain API. It matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
    - `payload_version` string, required — Version identifier to allow modifications to KYC data Object without needing to bump version of entire API set. Set to 1
    - `type` 'individual' | 'entity', required
    - `given_name` string — Legal given name of the user for which this KYC data Object applies.
    - `surname` string — Legal surname of the user for which this KYC data Object applies.
    - `address` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `dob` string — Date of birth for the holder of this account. Specified as an ISO 8601 calendar date format: https://en.wikipedia.org/wiki/ISO_8601
    - `place_of_birth` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `national_id` NationalId — National ID information for the holder of this account
      - `id_value` string, required — Indicates the national ID value - for example, a social security number
      - `county` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `type` string — Indicates the type of the ID
    - `legal_entity_name` string — Name of the legal entity. Used when subaddress represents a legal entity rather than an individual. KycData should only include one of legal_entity_name OR given_name/surname
  - `soft_reject` KycDataObject, required — A KycDataObject represents the know your customer or know your client (KYC) data required for exchanging KYC data in Diem off-chain API. It matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
    - `payload_version` string, required — Version identifier to allow modifications to KYC data Object without needing to bump version of entire API set. Set to 1
    - `type` 'individual' | 'entity', required
    - `given_name` string — Legal given name of the user for which this KYC data Object applies.
    - `surname` string — Legal surname of the user for which this KYC data Object applies.
    - `address` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `dob` string — Date of birth for the holder of this account. Specified as an ISO 8601 calendar date format: https://en.wikipedia.org/wiki/ISO_8601
    - `place_of_birth` Address
      - `city` string — The city, district, suburb, town, or village
      - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `line1` string — Address line 1
      - `line2` string — Address line 2 - apartment, unit, etc.
      - `postal_code` string — ZIP or postal code
      - `state` string — State, county, province, region.
    - `national_id` NationalId — National ID information for the holder of this account
      - `id_value` string, required — Indicates the national ID value - for example, a social security number
      - `county` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
      - `type` string — Indicates the type of the ID
    - `legal_entity_name` string — Name of the legal entity. Used when subaddress represents a legal entity rather than an individual. KycData should only include one of legal_entity_name OR given_name/surname

---

[API](https://skmtc.net/diem/apis/mini-wallet-api-specification.md) · [All operations](https://skmtc.net/diem/apis/mini-wallet-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/diem/mini-wallet-api-specification/revisions/b3821c80b8b2/schema)