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

# Get KYC sample data.

`GET /kyc_sample`

KYC sample data can be used for testing different behaviors during off-chain KYC data exchanging process. The data is used for counterparty wallet application to set up their 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` string, required — KycDataObject should be valid object that matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
  - `reject` string, required — KycDataObject should be valid object that matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
  - `soft_match` string, required — KycDataObject should be valid object that matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.
  - `soft_reject` string, required — KycDataObject should be valid object that matches Diem off-chain KycDataObject listed at https://dip.diem.com/dip-1/#kycdataobject.

## Changes

- **2021-03-02** `118633303045` — 12 breaking, 28 warning
  - the `minimum` response's property type/format changed from `object`/`` to `string`/`` for status `200`
  - the `reject` response's property type/format changed from `object`/`` to `string`/`` for status `200`
  - the `soft_match` response's property type/format changed from `object`/`` to `string`/`` for status `200`
  - the `soft_reject` response's property type/format changed from `object`/`` to `string`/`` for status `200`
  - …36 more

[Change history](https://skmtc.dev/diem/apis/mini-wallet-api-specification/changes/kyc_sample/get.md)

---

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