REST API›Identity›Know Your Business (KYB)

GET

Get Latest AutoKYB Outcome

Return the most recent AutoKYB analyze outcome for an identity. Same access as GET /v1/identities/:identityId. 404 if the identity is inaccessible or no pass has been recorded.

Path Params

  • identityId string required
    The unique ID of the identity

Responses

200
200

Response Body

object

  • status string enum required
    Status of the most recent AutoKYB analyze pass
    runningcompletepartialfailedskipped
  • mode string enum required
    AutoKYB operating mode used for the pass
    prefillsuggest
  • requestId string required
    Identifier of the AutoKYB analyze pass that produced this

    at least 1 characters

  • fields array of objects
    Per-field outcomes: filled, suggested, needs review, missing

    Defaults to []

    fields object
    • key string required
      Dotted path of the identity field, e.g. business.legalName

      at least 1 characters

    • proposedValue map nullable
      Value AutoKYB proposed for the field
    • currentValue map nullable
      Value already present on the identity at analyze time
    • source map nullable
      Provenance of the proposed value, e.g. the source document
    • confidence number
      Model confidence in the proposed value, between 0 and 1

      >= 0 · <= 1

    • action string enum required
      Outcome recorded for a single field
      wrotesuggestedskipped_user_ownedmissingneeds_review
  • gaps array of strings
    Field keys still missing after the pass

    Defaults to []

  • updatedAt string date-time required
    When the outcome was last written, ISO 8601
401
401

Response Body

object

  • error string required
    Description of the error
  • details array of strings
404
404

Response Body

object

  • error string required
    Description of the error
  • details array of strings
500
500

Response Body

object

  • error string required
    Description of the error
  • details array of strings