Get the nominative onboarding of a holder registry entry.

GET

https://api.t-dx.com/api/rest/v1/holder-registries/:registryId/entries/onboardings/:clientAccountId

GET

/api/rest/v1/holder-registries/:registryId/entries/onboardings/:clientAccountId

curl https://api.t-dx.com/api/rest/v1/holder-registries/registryId/entries/onboardings/clientAccountId \
     -H "Authorization: Bearer <token>"

{
  "result": {
    "id": "string",
    "userId": "string",
    "status": "ONBOARDING_STATUS_SUBMITTED",
    "onfidoStatus": "ONFIDO_STATUS_UNINITIALIZED",
    "onfidoApplicantId": "string",
    "onfidoCheckId": "string",
    "onfidoReportIds": [
      "string"
    ],
    "onfidoDocumentsRetrieved": true,
    "worldcheckCaseId": "string",
    "worldcheckStatus": "WORLDCHECK_STATUS_UNINITIALIZED",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "pii": {
      "attributes": [
        {
          "id": "string",
          "userId": "string",
          "clientAccountId": "string",
          "owner": "string",
          "type": "string",
          "subType": "string",
          "key": "string",
          "value": "string",
          "contentType": "string",
          "isFile": true,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "informationAddress": {
        "additionalInfo": "string",
        "street": "string",
        "streetNumber": "string",
        "city": "string",
        "country": "string",
        "zip": "string",
        "building": "string",
        "suite": "string",
        "floor": "string",
        "postalBox": "string"
      },
      "informationDetails": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "dateOfBirth": "2024-01-15T09:30:00Z",
        "nationalities": [
          "string"
        ],
        "details": "string",
        "pep": true
      },
      "informationDocuments": {
        "challenge": "string",
        "gtc": true,
        "cr": true,
        "dattc": true,
        "ritfi": true,
        "rtcda": true,
        "tsard": true,
        "irdcd": true,
        "eatc": true,
        "tor": true,
        "tdxrd": true,
        "ritsa": true,
        "fib": true,
        "eugtc": true
      },
      "informationFinalize": {
        "challenge": "string",
        "acquisitionSources": [
          "string"
        ],
        "otherAcquisitionSource": "string"
      },
      "informationFinancialSituation": {
        "annualIncome": "string",
        "netWealth": "string",
        "originsOfWealth": [
          "string"
        ],
        "otherOriginOfWealth": "string",
        "depositAmount": "string",
        "disposalAssets": "string",
        "soleOwnership": true,
        "finSAInvestorClassification": "FIN_SA_INVESTOR_CLASSIFICATION_RETAIL",
        "ProfessionalAttributes": [
          "string"
        ]
      },
      "informationProfessionalSituation": {
        "employmentStatus": "EMPLOYED",
        "position": "string",
        "sector": "string",
        "employmentCompanyName": "string",
        "employmentCountry": "string"
      },
      "informationStartIdentity": {
        "sentId": true,
        "sentProofOfAddress": true,
        "sentLivePic": true
      },
      "informationTaxExchange": {
        "switzerlandResidence": true,
        "countries": [
          "string"
        ],
        "tins": [
          "string"
        ],
        "reasons": [
          "string"
        ],
        "details": [
          "string"
        ],
        "acknowledgement": true,
        "exclusiveHomeResidence": true
      },
      "informationTaxUs": {
        "notBornInUs": true,
        "notGreenCardHolder": true,
        "notMeetPresenceTest": true,
        "notPresentInUs": true,
        "notUsCitizen": true,
        "notUsPerson": true
      }
    },
    "step": "STEP_PERSONAL_DETAILS",
    "reviewedAt": "2024-01-15T09:30:00Z",
    "identificationExpiresAt": "2024-01-15T09:30:00Z"
  }
}

This endpoint retrieves nominative onboarding information.It is accessible to issuers exclusively when the client account is or has been associated with the registry ID specified in the query string.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

registryIdstringRequiredformat: "uuid"

ID of the holder registry

clientAccountIdstringRequiredformat: "uuid"

ID of the client account

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error