Know Your Business (KYB)

Get KYB Identity

Retrieve an identity by its ID, including all related information. Requires User-Id header and user can only access identities they created.

get/api/identity-service/v1/identities/{identityId}

Path parameters

identityIdstring required

The unique ID of the identity to retrieve

Response

200

OR

Changes

Changed in 1 of the 16 revisions of this API.54738

  • 70b5f74b179954738See the full diff
    • the response property oneOf[subschema #1: IndividualIdentityResponse]/individual/address/subdivision became optional for the status 200

      response-property-became-optional

    • the response property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/address/subdivision became optional for the status 200

      response-property-became-optional

    • the response property oneOf[subschema #2: BusinessIdentityResponse]/business/billingAddress/subdivision became optional for the status 200

      response-property-became-optional

    • the response property oneOf[subschema #2: BusinessIdentityResponse]/business/mailingAddress/subdivision became optional for the status 200

      response-property-became-optional

    • the response property oneOf[subschema #2: BusinessIdentityResponse]/business/physicalBusinessAddress/subdivision became optional for the status 200

      response-property-became-optional

    • added the new Link enum value to the oneOf[subschema #1: IndividualIdentityResponse]/requestedProducts/items/name response property for the response status 200

      response-property-enum-value-added

    • added the new Link enum value to the oneOf[subschema #2: BusinessIdentityResponse]/requestedProducts/items/name response property for the response status 200

      response-property-enum-value-added

    • added the new agreement enum value to the oneOf[subschema #1: IndividualIdentityResponse]/requirements/items/kind response property for the response status 200

      response-property-enum-value-added

    • added the new agreement enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/missingRequirements/items/kind response property for the response status 200

      response-property-enum-value-added

    • added the new agreement enum value to the oneOf[subschema #2: BusinessIdentityResponse]/requirements/items/kind response property for the response status 200

      response-property-enum-value-added

    • added the new authorizedSignerForm enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new authorizedSignerForm enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new authorizedSignerForm enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new bankStatement enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new bankStatement enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new caseRequiredDocuments enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new caseRequiredDocuments enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new caseRequiredDocuments enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new certificateOfGoodStanding enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new certificateOfGoodStanding enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new certificateOfGoodStanding enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new computerizedPayslips enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new computerizedPayslips enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new correspondentAccountCertification enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new correspondentAccountCertification enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new correspondentAccountCertification enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new dptHoldingStatement enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new dptHoldingStatement enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new employmentLetterContract enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new employmentLetterContract enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new externalVerification enum value to the oneOf[subschema #1: IndividualIdentityResponse]/requirements/items/kind response property for the response status 200

      response-property-enum-value-added

    • added the new externalVerification enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/missingRequirements/items/kind response property for the response status 200

      response-property-enum-value-added

    • added the new externalVerification enum value to the oneOf[subschema #2: BusinessIdentityResponse]/requirements/items/kind response property for the response status 200

      response-property-enum-value-added

    • added the new incomeTaxAssessment enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new incomeTaxAssessment enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new investmentHoldingsStatement enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new investmentHoldingsStatement enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new other enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new other enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new proofOfAddress enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new proofOfAddress enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new proofOfAddress enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new propertyTaxCpfStatement enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new propertyTaxCpfStatement enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new singaporeSupportingDocument enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new singaporeSupportingDocument enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new singaporeSupportingDocument enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new sourceOfWealth enum value to the oneOf[subschema #1: IndividualIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new sourceOfWealth enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new sourceOfWealth enum value to the oneOf[subschema #2: BusinessIdentityResponse]/documents/items/documentType response property for the response status 200

      response-property-enum-value-added

    • added the new titleDeeds enum value to the oneOf[subschema #1: IndividualIdentityResponse]/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the new titleDeeds enum value to the oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/govIdClass response property for the response status 200

      response-property-enum-value-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/externalVerifications to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/accountOpeningPurpose to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/accreditedInvestorOptedIn to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/accreditedInvestorQualifyingCriteria to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/annualIncome to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/clientAttestationDate to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/clientAttestationReference to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/digitalAssetWalletAddress to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/employerName to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/jobTitle to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/multipleCitizenship to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/netWorth to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/occupationDetails to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/raaPassed to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/sourceOfFundOrigin to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/sourceOfFundOriginOfTransfer to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/sourceOfWealth to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: IndividualIdentityResponse]/individual/sourceOfWealthDetails to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/accountOpeningPurpose to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/accreditedInvestorOptedIn to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/accreditedInvestorQualifyingCriteria to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/annualIncome to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/clientAttestationDate to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/clientAttestationReference to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/digitalAssetWalletAddress to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/employerName to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/jobTitle to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/multipleCitizenship to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/netWorth to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/occupationDetails to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/raaPassed to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/sourceOfFundOrigin to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/sourceOfFundOriginOfTransfer to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/sourceOfWealth to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/individual/sourceOfWealthDetails to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: BusinessIdentityResponse]/externalVerifications to the response with the 200 status

      response-optional-property-added

    • the oneOf[subschema #2: BusinessIdentityResponse]/business/tradeStrategy response's property pattern was changed from ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$ to ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&"]+$ for the status 200

      response-property-pattern-changed

    • added the required property oneOf[subschema #2: BusinessIdentityResponse]/associatedPeople/items/associatedPersonId to the response with the 200 status

      response-required-property-added