Ana içeriğe geç

Doğrulama Oturumları Uç Noktası

Bir doğrulama sürecini başlatmak için aşağıdaki uç noktayı kullanın:

POST https://app.trustchex.com/api/v1/verification-sessions

API anahtarını başlıkta x-api-key olarak ekleyin.

İstek Gövdesi​

Gövdeye aşağıdaki özellikleri ekleyin:

{
    "workflowId": "<workflowId>",
    "email": "<kullanıcı email>",
    "phoneNumber": "<kullanıcı telefon>",
    "sendOTP": true,
    "locale": "<en|tr>",
    "duration": 30
}

JSON Özellikleri​

  • workflowId (string, zorunlu): Doğrulama için kullanılacak iş akışının kimliği. Bir iş akışını iş akışları bölümünde oluşturabilirsiniz.
  • email (string, isteğe bağlı): Doğrulanacak kullanıcının e-posta adresi. email veya phoneNumber sağlanmalıdır, ancak ikisi birden değil.
  • phoneNumber (string, isteğe bağlı): Doğrulanacak kullanıcının telefon numarası. phoneNumber veya email sağlanmalıdır, ancak ikisi birden değil.
  • sendOTP (boolean, isteğe bağlı, varsayılan: true): true olarak ayarlanırsa, kullanıcının e-postası veya telefon numarası Tek Kullanımlık Şifre ile doğrulanacaktır. Kullanıcının gerçek sahibi olduğunu zaten doğruladıysanız, süreci kolaylaştırmak için bunu false olarak ayarlayabilirsiniz.
  • locale (string, zorunlu): Doğrulama süreci için dil tercihi. Kabul edilebilir değerler en İngilizce ve tr Türkçe'dir.
  • duration (tamsayı, isteğe bağlı): Doğrulama oturumunun süresi dakika cinsinden. Varsayılan değer 30 dakikadır.

JavaScript Fetch Örneği​

JavaScript'in fetch kullanarak API isteğini nasıl yapacağınızın bir örneği:

const url = 'https://app.trustchex.com/api/v1/verification-sessions';
const apiKey = 'API_ANAHTARINIZ';
const requestBody = {
    email: '[email protected]',
    workflowId: 'workflow123',
    sendOTP: true,
    locale: 'en',
    duration: 30
};

fetch(url, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'x-api-key': apiKey
    },
    body: JSON.stringify(requestBody)
})
.then(response => response.json())
.then(data => {
    console.log('Success:', data);
})
.catch((error) => {
    console.error('Error:', error);
});

Başarılı Yanıt​

Başarılı bir yanıt, aşağıdaki yapıya sahip bir JSON nesnesi döndürecektir:

{
    "id": "<verificationSessionId>",
    "identificationId": "<identificationId>",
    "deepLink": "trustchex://app-url/https://app.trustchex.com/verification-session/<verificationSessionId>",
    "qrCodeLink": "https://app.trustchex.com/api/v1/verification-sessions/<verificationSessionId>/qr-code",
    "sessionPageLink": "https://app.trustchex.com/public/verification-sessions/<verificationSessionId>"
}

Yanıt Özellikleri​

  • id (UUID): Doğrulama oturumunun benzersiz tanımlayıcısı.
  • identificationId (UUID): Kimlik doğrulama sürecinin benzersiz tanımlayıcısı.
  • deepLink (string): Doğrulama oturumu için bir derin bağlantı URL'si.
  • qrCodeLink (string): Doğrulama oturumu için QR koduna bir URL.
  • sessionPageLink (string): Kullanıcının mobil uygulama bağlantılarını ve bir QR kodu veya derin bağlantıyı birlikte bulabileceği doğrulama oturumu sayfasına bir URL.

deepLink ve qrCodeLink, KYC çözümünü entegre eden uygulamada kullanıcıyı mobil uygulamaya yönlendirmek için kullanılmalıdır.

  • Derin Bağlantı: Kullanıcıyı bağlantıya tıklayarak doğrudan mobil uygulamaya göndermek için deepLink kullanılabilir.
  • QR Kod Bağlantısı: Kullanıcıyı mobil uygulamaya yönlendirmek için tarayabileceği bir QR kodu oluşturmak için qrCodeLink kullanılabilir.

Hata Yönetimi​

İstekle ilgili bir hata varsa, API uygun bir HTTP durum kodu ve hata ayrıntılarını içeren bir JSON nesnesi döndürecektir.

  • 400 Bad Request: İstek gövdesi geçersiz veya gerekli alanlar eksik.
  • 401 Unauthorized: API anahtarı eksik veya geçersiz.
  • 500 Internal Server Error: Sunucuda bir hata oluştu.

Bu hataları uygulamanızda uygun şekilde yönettiğinizden emin olun.