Know Your Business (KYB)

Update KYB Identity

Update an existing identity with new information. Requires User-Id header and user can only update identities they created. Only the fields provided in the request body will be updated.

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

Path parameters

identityIdstring required

The unique ID of the identity to update

Request body

finalizeSubmissionboolean

Whether identity is ready for final submission and requirements validation

Response

200

OR

Changes

Changed in 2 of the 33 revisions of this API.325180

  • abacf80da2fd2735See the full diff
    • ▲

      the // request property type changed from no type to string

      request-property-type-changed

    • ▲

      the / request property type changed from no type to string

      request-property-type-changed

    • ▲

      the // request property type changed from no type to string

      request-property-type-changed

    • ▲

      the // request property type changed from no type to string

      request-property-type-changed

    • ▲

      the / request property type changed from no type to string

      request-property-type-changed

    • ▲

      the / request property type changed from no type to string

      request-property-type-changed

    • ▲

      the // request property type changed from no type to string

      request-property-type-changed

    • ▲

      the / request property type changed from no type to string

      request-property-type-changed

    • ▲

      the / request property type changed from no type to string

      request-property-type-changed

    • ▲

      the / request property type changed from no type to string

      request-property-type-changed

    • ▲

      the // request property type changed from no type to string

      request-property-type-changed

    • ▲

      the /// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the /// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the ///// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the //// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the //// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the //// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the /// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the /// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the /// response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the /// response's property type changed from no type to string for status

      response-property-type-changed

    • ●

      added the new financialCrimeComplianceQuestionnaire enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new financialCrimeComplianceQuestionnaire enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new financialCrimeComplianceQuestionnaire enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new financialCrimeComplianceQuestionnaire enum value to the request property //

      request-property-enum-value-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 70b5f74b179954875See the full diff
    • ▲

      the response property /// became optional for the status

      response-property-became-optional

    • ▲

      the response property ///// became optional for the status

      response-property-became-optional

    • ▲

      the response property /// became optional for the status

      response-property-became-optional

    • ▲

      the response property /// became optional for the status

      response-property-became-optional

    • ▲

      the response property /// became optional for the status

      response-property-became-optional

    • ●

      changed the pattern of the request property / from ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-\.,()"]+$ to ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ0-9\s'\-\.,#\/( )&"]+$

      request-property-pattern-changed

    • ●

      added the new Link enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Link enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new agreement enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new agreement enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new agreement enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new authorizedSignerForm enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new authorizedSignerForm enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new authorizedSignerForm enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new bankStatement enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new bankStatement enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new caseRequiredDocuments enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new caseRequiredDocuments enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new caseRequiredDocuments enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new certificateOfGoodStanding enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new certificateOfGoodStanding enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new certificateOfGoodStanding enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new computerizedPayslips enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new computerizedPayslips enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new correspondentAccountCertification enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new correspondentAccountCertification enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new correspondentAccountCertification enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new dptHoldingStatement enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new dptHoldingStatement enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new employmentLetterContract enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new employmentLetterContract enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new externalVerification enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new externalVerification enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new externalVerification enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new incomeTaxAssessment enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new incomeTaxAssessment enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new investmentHoldingsStatement enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new investmentHoldingsStatement enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new other enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new other enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new proofOfAddress enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new proofOfAddress enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new proofOfAddress enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new propertyTaxCpfStatement enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new propertyTaxCpfStatement enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new singaporeSupportingDocument enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new singaporeSupportingDocument enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new singaporeSupportingDocument enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sourceOfWealth enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sourceOfWealth enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sourceOfWealth enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new titleDeeds enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new titleDeeds enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      the request property // became optional

      request-property-became-optional

    • ○

      the request property // became optional

      request-property-became-optional

    • ○

      the request property // became optional

      request-property-became-optional

    • ○

      the request property // became optional

      request-property-became-optional

    • ○

      added the new authorizedSignerForm enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new bankStatement enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new caseRequiredDocuments enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new certificateOfGoodStanding enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new computerizedPayslips enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new correspondentAccountCertification enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new dptHoldingStatement enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new employmentLetterContract enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new incomeTaxAssessment enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new investmentHoldingsStatement enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new other enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new proofOfAddress enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new propertyTaxCpfStatement enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new singaporeSupportingDocument enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new sourceOfWealth enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new titleDeeds enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

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

      response-property-pattern-changed

    • ○

      added the required property /// to the response with the status

      response-required-property-added