GET/v1/definitions/{key}/rows/{rowId}/super-kyc

Read a record's Super KYC links

One record's Super KYC links, newest first, live and stopped: which sources each asked for (google, plaid), its status (sent, opened, agreed, watching, stopped, expired), the banks and Google account connected, and the count of open and critical findings. Any page's record. The link's token is never here.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

rowIdpath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

:rowIdstringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "banks": [
        "string"
      ],
      "businessName": "string",
      "consentedAt": "string",
      "createdAt": "string",
      "createdBy": 1.5,
      "email": "string",
      "expiresAt": "string",
      "flags": {
        "critical": 1.5,
        "open": 1.5
      },
      "id": "",
      "name": "string",
      "openedAt": "string",
      "rowId": "",
      "sources": [
        "string"
      ],
      "status": "string",
      "stoppedBy": "string"
    }
  ]
}

dataarray<>required

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired