Off-chain

Get KYC sample data.

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.

get/kyc_sample

Response

success

Example response

{
  "minimum": {
    "type": "individual",
    "payload_version": 1,
    "given_name": "Tom",
    "surname": "Jack"
  },
  "reject": {
    "type": "individual",
    "payload_version": 1,
    "given_name": "Tom",
    "surname": "Jack"
  },
  "soft_match": {
    "type": "individual",
    "payload_version": 1,
    "given_name": "Tom",
    "surname": "Jack"
  },
  "soft_reject": {
    "type": "individual",
    "payload_version": 1,
    "given_name": "Tom",
    "surname": "Jack"
  }
}

Changes

Changed in 2 of the 6 revisions of this API.162836

Apr 12, 202164ebf1d3c93a436See the full diff
- ▲
  the minimum response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ▲
  the reject response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ▲
  the soft_match response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ▲
  the soft_reject response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ○
  added the optional property minimum/address to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property minimum/dob to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property minimum/given_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property minimum/legal_entity_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property minimum/national_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property minimum/place_of_birth to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property minimum/surname to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/address to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/dob to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/given_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/legal_entity_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/national_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/place_of_birth to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reject/surname to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/address to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/dob to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/given_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/legal_entity_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/national_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/place_of_birth to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_match/surname to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/address to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/dob to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/given_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/legal_entity_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/national_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/place_of_birth to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property soft_reject/surname to the response with the 200 status
  response-optional-property-added
- ○
  added the required property minimum/payload_version to the response with the 200 status
  response-required-property-added
- ○
  added the required property minimum/type to the response with the 200 status
  response-required-property-added
- ○
  added the required property reject/payload_version to the response with the 200 status
  response-required-property-added
- ○
  added the required property reject/type to the response with the 200 status
  response-required-property-added
- ○
  added the required property soft_match/payload_version to the response with the 200 status
  response-required-property-added
- ○
  added the required property soft_match/type to the response with the 200 status
  response-required-property-added
- ○
  added the required property soft_reject/payload_version to the response with the 200 status
  response-required-property-added
- ○
  added the required property soft_reject/type to the response with the 200 status
  response-required-property-added
Mar 2, 20211186333030451228See the full diff
- ▲
  the minimum response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ▲
  the reject response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ▲
  the soft_match response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ▲
  the soft_reject response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ▲
  removed the required property minimum/payload_version from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property minimum/type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property reject/payload_version from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property reject/type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property soft_match/payload_version from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property soft_match/type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property soft_reject/payload_version from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property soft_reject/type from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property minimum/address from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property minimum/dob from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property minimum/given_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property minimum/legal_entity_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property minimum/national_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property minimum/place_of_birth from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property minimum/surname from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/address from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/dob from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/given_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/legal_entity_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/national_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/place_of_birth from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reject/surname from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/address from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/dob from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/given_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/legal_entity_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/national_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/place_of_birth from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_match/surname from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/address from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/dob from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/given_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/legal_entity_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/national_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/place_of_birth from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property soft_reject/surname from the response with the 200 status
  response-optional-property-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history