Skip to main content
Hesaplar ve kullanıcılar, Whop’un ödemeleri veya uyumluluk açısından hassas iş akışlarını etkinleştirmeden önce kim olduklarını doğrulaması gerektiğinde doğrulamayı tamamlar. Verifications API’yi barındırılan bir doğrulama oturumunu başlatmak veya sürdürmek, inceleme durumunu kontrol etmek ve istenen ayrıntıları veya belgeleri göndermek için kullanın. requested_information öğeler içeriyorsa, yanıtları Doğrulamayı Güncelle ile gönderin.
Legacy Verifications kaynağının yerini alır. Mevcut Legacy entegrasyonları çalışmaya devam eder; kararlılık sözleşmesi için API sürümleri sayfasına bakın.

Uç noktalar

Öznitelikler

string
Doğrulama profili kimliği, idpf_ önekli.
string[]
gerekli
Bu doğrulamanın okunduğu hesaplar, her biri biz_ önekli: listelemede kullandığınız hesap, include_subaccounts ile ait olduğu hesap veya alt hesap ya da kimliğe göre getirildiğinde ait olduğu ve okuyabildiğiniz her hesap. Genellikle bir tanedir. Kişisel bir doğrulama için boştur.
object | null
Doğrulama profilindeki adres. Adres ayarlanmadığında null.

Özellikler

string | null
string | null
İki harfli ISO 3166-1 ülke kodu, örneğin US, DE veya GB.
string
Sokak adresinin ilk satırı.
string | null
Sokak adresinin ikinci satırı.
string | null
Posta kodu.
string | null
Eyalet, il veya bölge kodu, örneğin CA.
string | null
Yasal işletme adı.
string | null
İşletmenin yasal kuruluş yapısı, örneğin private_corporation veya sole_proprietorship. Desteklenen değerler kuruluş ülkesine göre değişir — bkz. İşletme yapıları.
string | null
İki harfli ISO 3166-1 ülke kodu, örneğin US, DE veya GB.
string
Doğrulama profilinin oluşturulduğu zaman, ISO 8601 zaman damgası olarak.
string | null
YYYY-MM-DD biçiminde.
string | null
Doğrulama profilindeki e-posta adresi.
string | null
string | null
İşletmenin kurulduğu tarih, YYYY-MM-DD biçiminde, işletme doğrulaması için kayıtlı olduğu şekliyle. Yalnızca işletme doğrulamaları; gönderilene kadar null.
string
Kullanılabilir seçenekler: individual, business
string | null
object[]
gerekli
İşletmenin sahipleri ve her birinin kendi doğrulamasının ilerleyişi. Bireysel doğrulamalar için boştur.

Özellikler

string
gerekli
Sahip kimliği, own_ önekli. Barındırılan oturumda eklenen sahip dahil, sahibi değiştirmek veya kaldırmak için bunu Update Verification’ın owners alanında gönderin.
string | null
gerekli
Sahibin kayıtlı doğum tarihi, YYYY-MM-DD biçiminde.
string | null
gerekli
string | null
gerekli
number | null
gerekli
Kişinin sahip olduğu işletme payı, 0 ile 100 arasında.
string[]
gerekli
Sahibin doğrulaması geri gönderildiğinde sağlayıcının neyi reddettiği: details (adı, doğum tarihi veya diğer ayrıntıları kimliğiyle eşleşmiyor), identity_document veya selfie. Yalnızca bunları Update Verification ile düzeltin. Aksi halde boştur.Kullanılabilir seçenekler: details, identity_document, selfie
object[]
gerekli
Sahibin belgeleri ve ilerleyişleri. verification_id ile eklenen bir sahip için boştur.

Özellikler

string
Belge yuvası anahtarı, örneğin id_card_front, id_card_back veya selfie.
string | null
Sağlayıcı yeni belgeler istediğinde veya doğrulamayı reddettiğinde, önceki gönderimin neden reddedildiği.
string
Belge incelemeye iletilene kadar pending_upload; sonrasında submitted.Kullanılabilir seçenekler: pending_upload, submitted
string[]
gerekli
Kişinin işletmeyle ilişkisi.Kullanılabilir seçenekler: ubo, director, representative, shareholder
string
gerekli
Sahibin kendi doğrulamasının durumu, status ile aynı durumlarda. Belgelerinin yeniden gönderilmesi gerektiğinde action_required.Kullanılabilir seçenekler: not_started, pending, processing, manual_review, approved, rejected, action_required
string | null
Doğrulama profilindeki telefon numarası.
string | null
İşletmenin kurulduğu eyalet veya bölge, işletme doğrulaması için kayıtlı olduğu şekliyle. Yalnızca işletme doğrulamaları; gönderilene kadar null.
string | null
İşletmenin kuruluş yerinde kayıtlı olduğu numara, örneğin ABD’de bir eyalet dosya numarası veya Birleşik Krallık’ta bir Company Number. Yalnızca işletme doğrulamaları; işletme doğrulaması için kayıtlı olduğu şekliyle veya gönderilene kadar null.
object[]
İncelemenin devam edebilmesi için Whop’un hâlâ neye ihtiyaç duyduğu; giriş başına bir gereksinim. Update Verification ile yanıtlayın. Yanıttan hiçbir şey geri yansıtılmaz. Geçerli olmayan anahtarlar atlanır. documents veya owners ile oluşturulan bir işletme doğrulaması için bu, incelemeye gönderilmeden önce hâlâ eksik olan işletme ayrıntılarını ve belgeleri içerir. Her sahibin belgeleri o sahibin altında listelenir.

Özellikler

string
gerekli
İstenen bilgi öğesi kimliği, inrqi_ önekli.
string
İlgili bir eylem için URL, örneğin canlılık doğrulamasını tamamlama veya bir ödemeyi görüntüleme. Kullanılabilir eylem olmadığında bulunmaz.
string
Bu öğeyi value yerine yanıtlayan bir belge, örneğin EIN eşleştirilemediğinde bir IRS EIN mektubu. Sayfalarını düzeltilmiş bir value ile veya olmadan files içinde gönderin. Yalnızca value kabul edildiğinde bulunmaz.
string
Bu gereksinimle birlikte gösterilen takip sorusu.
boolean
Görünür olduğunda takip yanıtının zorunlu olup olmadığı.
string[]
Takip sorusunu görünür kılan seçili seçenek değerleri.
object[]
Reddedilen bir gönderimden sonra bulunur.

Özellikler

string
Sabit hata kodu.
string
Neden reddedildiği.
string
gerekli
Kullanıcıya gösterilecek talimat. Varsa incelemecinin notunu aynen taşır.
boolean
Öğe atlanabildiğinde true.
string[]
Bir select öğesinde value alanının alabileceği değerler. Bir id_document öğesinde bunlar kabul edilen kimlik türleridir ve seçilen tür hangi documents yuvalarının gönderileceğini belirler. Öğede yapılacak bir seçim olmadığında bulunmaz.
string
gerekli
Neyin gerektiği: bank_statement gibi bir belge adı veya ssn ya da identity_document gibi bir alan anahtarı. Tanınmayan değerleri type alanına göre işleyin.
string
Metin yanıtı için isteğe bağlı yerel giriş biçimi.Kullanılabilir seçenekler: yes_no, yes_no_na, date, url, number, tel
string
options içeren bir sorunun tek bir değer mi yoksa birden fazla değer mi kabul ettiği.Kullanılabilir seçenekler: single, multiple
object[]
Bağlam için gereksinimle birlikte sağlanan belgeler.

Özellikler

string
gerekli
Dosyanın kimliği, file_ önekli.
string | null
gerekli
Bir görsel veya video için BlurHash yer tutucusu. Mevcut olmadığında veya moderasyon tarafından kaldırıldığında Null.
string | null
gerekli
Orijinal dosyanın MIME türü, örneğin application/pdf. Moderasyon dosyayı kaldırdığında korunur.
string
gerekli
Dosyanın oluşturulduğu zaman, ISO 8601 zaman damgası olarak.
number | null
gerekli
Saniye cinsinden ses veya video süresi. Mevcut olmadığında veya moderasyon tarafından kaldırıldığında Null.
string | null
gerekli
Uzantısı dahil orijinal dosya adı.
integer | null
gerekli
Piksel cinsinden görsel veya video yüksekliği. Mevcut olmadığında veya moderasyon tarafından kaldırıldığında Null.
integer | null
Her parçanın (sonuncusu hariç) olması gereken bayt boyutu. Yalnızca oluşturmada ve yalnızca çok parçalı yüklemeler için bulunur.
string | null
complete çağrısına geri iletilen çok parçalı yüklemenin kimliği. Yalnızca oluşturmada ve yalnızca çok parçalı yüklemeler için bulunur.
object[] | null
Her parça için önceden imzalanmış URL. Yalnızca oluşturmada ve yalnızca çok parçalı yüklemeler için bulunur.

Özellikler

integer
gerekli
Bu parçanın çok parçalı yükleme içindeki 1 tabanlı dizini.
string
gerekli
Bu parçanın baytlarının PUT ile gönderileceği önceden imzalanmış URL.
string
gerekli
Bu nesnenin türü, her zaman file.
boolean
gerekli
Moderasyonun dosyayı kaldırıp kaldırmadığı. true olduğunda url yerine geçen bir görsel sunar. filename, size ve content_type hâlâ orijinal dosyayı tanımlar.
integer | null
gerekli
Bayt cinsinden dosya boyutu. Yükleme tamamlanana kadar null.
object
Yükleme PUT isteğiyle gönderilecek başlıklar. Yalnızca oluşturmada bulunur.
string
gerekli
Dosyanın yükleme yaşam döngüsünde nerede olduğu.Kullanılabilir seçenekler: pending, processing, ready, failed
string | null
Dosyanın baytlarının PUT ile gönderileceği önceden imzalanmış URL. Yalnızca oluşturmada ve yalnızca tek parçalı yüklemeler için bulunur.
string | null
gerekli
Dosyayı indirmek için bir URL. Herkese açık dosyalar kalıcı bir CDN URL’si, özel dosyalar ise süresi dolan imzalı bir URL alır. Yükleme tamamlanana kadar null. Moderasyon dosyayı kaldırdığında, yerine geçen bir görsel URL’si.
string
gerekli
public dosyalar imzasız bir CDN URL’sinden sunulur. private dosyalar süresi dolan imzalı bir URL’den sunulur.Kullanılabilir seçenekler: public, private
string | null
gerekli
Ses dalga formu URL’si. Mevcut olmadığında veya moderasyon tarafından kaldırıldığında Null.
integer | null
gerekli
Piksel cinsinden görsel veya video genişliği. Mevcut olmadığında veya moderasyon tarafından kaldırıldığında Null.
boolean
Yazılı bir açıklamanın gerekli destekleyici dosyaların yerine geçip geçemeyeceği.
boolean
Bu gereksinimin ayrıca destekleyici dosyalar gerektirip gerektirmediği.
string[]
Destekleyici dosya girişini görünür kılan seçili seçenek değerleri.
string
gerekli
Yanıt olarak ne gönderileceği, böylece asla tahmin etmek zorunda kalmazsınız: files (sayfalarının listesi olarak bir belge), id_document (yüklediğiniz kimliğin yuva anahtarlarıyla documents gönderin), text, date, phone veya select (value gönderin), text_with_files (value ve isteğe bağlı files gönderin), address (address gönderin) veya liveness (action_url adresini açın, ardından tamamlandıktan sonra value değerini true olarak gönderin).
object[]
Belge yüklemeli bir doğrulamanın belgeleri ve ilerleyişleri. Yalnızca documents gönderilerek oluşturulan bireysel doğrulamalarda bulunur. pending_upload belgeleri henüz kabul edilmemiştir — tüm kümeyi başka bir Create Verification çağrısıyla yeniden gönderin.

Özellikler

string
Belge yuvası anahtarı, örneğin id_card_front, id_card_back veya selfie.
string | null
Sağlayıcı yeni belgeler istediğinde veya doğrulamayı reddettiğinde, önceki gönderimin neden reddedildiği.
string
Belge incelemeye iletilene kadar pending_upload; sonrasında submitted.Kullanılabilir seçenekler: pending_upload, submitted
string | null
Kullanıcının kimlik kontrollerini tamamlaması için barındırılan doğrulama oturumu URL’si. Oluşturulduktan 7 gün sonra süresi dolar.
string
Mevcut doğrulama durumu. Herhangi bir oturum yokken not_started; bir oturum kullanıcının girdisini beklerken pending; sağlayıcının otomatik kontrolleri yeni bir gönderim üzerinde çalışırken processing; requested_information yanıt gerektirdiğinde action_required; zaten gönderilmiş bilgiler incelenirken manual_review — bir denetim yanıtı veya ödeme sağlayıcısının tuttuğu bir belge — gönderilecek bir şey yoktur, genellikle 3 iş günü içinde tamamlanır; başarı durumunda approved; başarısızlık durumunda rejected. Yeni bir oturum başlatmak için Create Verification’ı yeniden çağırın.Kullanılabilir seçenekler: not_started, pending, processing, manual_review, approved, rejected, action_required
string
Doğrulama profilinin son güncellendiği zaman, ISO 8601 zaman damgası olarak.
Verification