Know Your Business (KYB)

Update KYB Identity

Changed on

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}

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/identity-service/v1/identities/{identityId}
  • Auth
    none declared

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

    • warning

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

    • warning

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

    • breaking

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

    • breaking

      the / request property type changed from no type to string

    • breaking

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

    • breaking

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

    • breaking

      the / request property type changed from no type to string

    • breaking

      the / request property type changed from no type to string

    • breaking

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

    • breaking

      the / request property type changed from no type to string

    • breaking

      the / request property type changed from no type to string

    • breaking

      the / request property type changed from no type to string

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status