/v3/businesses/. Diese Seite bietet einen konzeptionellen Überblick. Die vollständigen Schemas für Anfragen und Antworten finden Sie in der API-Referenz.
Unternehmen auflisten
GET /v3/businesses/
Paginierte Liste der Unternehmen für Ihre Anwendung mit Filtern für Status, Suchbegriff, Land und Datumsbereich.
Ein Unternehmen abrufen
GET /v3/businesses/{vendor_data}/
Ruft ein einzelnes Unternehmen anhand von vendor_data ab.
Ein Unternehmen anlegen
POST /v3/businesses/create/
Legen Sie ein Unternehmen vorab an, bevor eine Sitzung der Unternehmensverifizierung (KYB) ausgeführt wird:
vendor_data existiert. Verwenden Sie PATCH, um ein bestehendes Unternehmen zu aktualisieren.
Ein Unternehmen aktualisieren
PATCH /v3/businesses/{vendor_data}/
Aktualisieren Sie änderbare Profilfelder. Felder, die aus Registerabfragen stammen (legal_name, registration_number, country_code), sind nach der Verifizierung schreibgeschützt, können aber überschrieben werden. Überschreibungen werden im Audit-Log markiert.
Änderbare Felder: display_name, metadata, tags.
Nach der Verifizierung schreibgeschützt: alle aus Registerdaten abgeleiteten Felder, Summenzähler, features-Map.
business.data.updated aus.
Status ändern
PATCH /v3/businesses/{vendor_data}/update-status/
Verschieben Sie ein Unternehmen zwischen ACTIVE, FLAGGED und BLOCKED.
Löst
business.status.updated aus.
Unternehmen löschen (Batch)
POST /v3/businesses/delete/
Löscht ein oder mehrere Unternehmen. Die Unternehmensdatensätze werden dauerhaft entfernt. Ihre Verifizierungssitzungen sind von diesem Endpoint nicht erfasst und bleiben erhalten, wobei ihre Verknüpfung mit dem Unternehmen entfernt wird. Löschen Sie diese mit Sitzung löschen. Transaktionen sind ebenfalls nicht erfasst. Löschen Sie diese über die Konsole.
Berechtigungsmodell
Alle Endpoints unter/v3/businesses/* werden über die Berechtigungsressource businesses gesteuert:
Siehe Rollen und Berechtigungen.
Von diesen Vorgängen ausgelöste Webhooks
Nächste Schritte
Datenmodell
Vollständige Feldreferenz.
List-API
Schema für GET /v3/businesses/.
Erstellungs-API
Schema für POST /v3/businesses/create/.