Saltar al contingut principal
GET
curl

Visió general

Retorna una única entitat empresa identificada per vendor_data.

Quan utilitzar-lo

  • Consulta de l’estat de verificació actual d’una empresa: el mapa features et mostra d’un cop d’ull l’estat més recent de cada funcionalitat KYB.
  • Vistes de detall a la teva pròpia interfície d’administració.
  • Puntuació de risc a partir dels comptadors agregats i dels estats de les funcionalitats.

Notes

  • vendor_data a la URL distingeix entre majúscules i minúscules.
  • Retorna 404 si no existeix cap empresa amb aquest vendor_data.
  • Els comptadors agregats (session_count, approved_count, declined_count, in_review_count) s’actualitzen en temps real a mesura que es completen les sessions de Verificació d’empreses (KYB).
  • Els camps derivats del registre (legal_name, registration_number, country_code) reflecteixen la sessió de Verificació d’empreses (KYB) aprovada més recent.

Permisos

El rol ha de concedir read:businesses.

Relacionat

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

vendor_data
string
requerit

El teu identificador únic per a l'empresa — una cadena de text lliure (NO un UUID), que coincideix exactament amb el valor enviat.

Resposta

Detall complet de l'empresa, incloses les metadades i les dades agregades de la sessió.

Detall complet de l'empresa. Amplia BusinessListItem amb metadades i updated_at.

didit_internal_id
string<uuid>

UUID intern estable de Didit per a aquesta empresa.

vendor_data
string | null

El teu identificador únic per a aquesta empresa (passat en crear sessions). Pot ser nul quan no s'ha proporcionat cap identificador de proveïdor.

display_name
string | null

Nom visible personalitzat definit per tu

Nom legal oficial obtingut del registre mercantil o introduït manualment

registration_number
string | null

Número de registre o de constitució de l'empresa

country_code
string | null

País de constitució (ISO 3166-1 alpha-2, p. ex. GB, US).

effective_name
string | null

Millor nom disponible: display_name si està definit, en cas contrari legal_name

status
enum<string>

Estat del cicle de vida del registre d'empresa (NO és un estat de la sessió). ACTIVE és el valor per defecte, FLAGGED el marca per a atenció manual, BLOCKED impedeix noves sessions per a aquest vendor_data.

Opcions disponibles:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Nombre total de sessions de verificació per a aquesta empresa

approved_count
integer

Nombre de sessions aprovades

declined_count
integer

Nombre de sessions rebutjades

in_review_count
integer

Nombre de sessions en revisió

features
object

Estat agregat per funcionalitat a totes les sessions de KYB d'aquesta empresa. Actualment l'única clau és KYB (l'estat de la comprovació de l'empresa al registre). Valors possibles: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Les mateixes dades que features, com una llista ordenada d'objectes {feature, status}.

last_session_at
string<date-time> | null

Marca de temps de la sessió més recent

first_session_at
string<date-time> | null

Marca de temps de la primera sessió

last_activity_at
string<date-time> | null

Marca de temps de l'activitat més recent (canvi d'estat, actualització de la sessió, etc.)

tags
object[]

Etiquetes assignades a aquesta empresa

created_at
string<date-time>
metadata
object

JSON de metadades personalitzades que has adjuntat a aquesta empresa. Per defecte és {}.

updated_at
string<date-time>
Darrera modificació el 7 de novembre del 2026