Ana içeriğe geç

Organizations

Genel Bakış

ClearTX ekosistemindeki kayıtlı KVHS organizasyonlarının listesini döndürür. Bu endpoint, travel rule uyumluluğu kapsamında hangi organizasyonların Travel Rule mesajlaşması için hazır olduğunu öğrenmek isteyen originator veya beneficiary KVHS'ler tarafından kullanılır.

Endpoint

GET /v1/organizations

İstek Parametreleri

Başlıklar

ParameterTürGerekliAçıklama
x-api-keystringEvetKurumunuza ait API anahtarı
Content-TypestringHayırapplication/json

Path Parametreleri

Bu endpoint herhangi bir path parametresi gerektirmez.

Sorgu Parametreleri

Bu endpoint herhangi bir sorgu parametresi gerektirmez.

İstek Gövdesi

Bu endpoint istek gövdesi beklemez.

Yanıt

Başarılı Yanıt (200 OK)

{
"organizations": [
{
"id": "8153dfa3-9c03-43b5-8ce7-468df4e62134",
"name": "Bitcoin Exchange",
"travelEndpoint": "https://cleartx.bitcoin.example/v1/transactions",
"publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtWg+oKv76kO1F6L2e6cWVM7gPCkDV1MIzyOj6ycpV8MtV0W0zTTf8gTtYt0e2LLDd3Q2NXhEn3kPmsZt3d6IA7baoXllmT1t+H4GQKJ6rARnq1n87wQrXl3KdbJLCQjWm5oR3+1Jk4wZ6nS5V+IzfHnNuM4JgJY0Pi6T4OkXzgLx2ldg9Pq3Q7h0Iqu7oMeOrnqHpDFl5zpq3XuiOJ+l0P2yvSqW9sZpX7kMBZKs1RVtmVv7khoFjSIkM6R+rHvPlJNb9LQIDAQAB",
"vaspDid": "did:web:bitcoin.example",
"organizationType": "unverified"
},
{
"id": "8a805d4d-72df-446f-989f-37d96b8d2c35",
"name": "Ethereum Exchange",
"travelEndpoint": "https://cleartx.ethereum.example/v1/transactions",
"publicKey": "MIIBCgKCAQEA0T7SGNf30CI7bM6qE5wQ1sD9XoQzFqGnbHp1t5OgdK72YppL8NoGw5r7C3v7N3b8t1kjX7G7a6SLRJsVZmkADW7jFZnh+1m+5k9YOr7PcqIyaI7LqKfrYp1lVY+W+v1DKQ1L4giy4bpuH12YlwzV4o6ykE0R9a+Mhq6IbXDyex8GI1jCbwyPzDx4XyAihssbTR7G8q9sZl0FCsSkcxjaxZJx1JrUan+DPYceS4r+gwIDAQAB",
"vaspDid": "did:web:ethereum.example",
"organizationType": "verified"
}
]
}

Yanıt Alanları

AlanTürAçıklama
organizationsarrayNetwork'taki KVHS organizasyonlarının listesi
organizations[].idstringOrganizasyon için benzersiz tanımlayıcı
organizations[].namestringOrganizasyonun görünen adı
organizations[].travelEndpointstringTravel Rule API endpoint URL'si
organizations[].publicKeystringTravel Rule mesajlarını şifrelemek için Public Key
organizations[].vaspDidstringOrganizasyona ait DID
organizations[].organizationTypestringOrganizasyonun doğrulama durumu (unverified, verified)

Notlar

  • Dönen organizasyon listesi, ClearTX ağına kayıtlı mevcut KVHS kataloğunu yansıtır.
  • travelEndpoint ve publicKey alanları, Travel Rule mesajlaşması için gerekli bağlantı ve şifreleme bilgilerini içerir.
  • Alanlardaki değerler örnektir; gerçek ortamda kurumunuzun paylaştığı bilgilerle eşleşir.
  • organizationType alanı organizasyonun ClearTX tarafından doğrulanmış olup olmadığını gösterir.