Identities

patch/identities/{identityId}/archive

Request

  • Base URL: https://api.allocations.com
  • URL: https://api.allocations.com/identities/{identityId}/archive
  • Auth: HTTP bearer

Path parameters

identityIdstring required

Unique identifier of the identity

Response

Identity archived successfully

idstring
deletedboolean
deletedOnstring date-time nullable
deletedBystring nullable
createdAtstring date-time
updatedAtstring date-time
userEmailstring nullable
userIdstring nullable
type'Individual' | 'Entity'
entityType'Entity' | 'LLC' | 'Corporation' | 'Partnership' | 'Joint' | 'IRA' | 'Trust' nullable
taxIdstring nullable
taxIdTypestring nullable
addressLine_1string nullable
addressLine_2string nullable
citystring nullable
regionstring nullable
countrystring nullable
postalCodestring nullable
usDomesticboolean nullable
entityIsDisregardedboolean nullable
ownershipPercentnumber nullable
phonestring nullable
parentIdentityIdstring nullable
providerstring nullable
providerIdstring nullable
dateOfEntityFormationstring date-time nullable
legalNamestring nullable
titlestring nullable
archivedboolean nullable
countryOfCitizenshipstring nullable
status'in_review' | 'failed' | 'success' | 'queued' | 'archived' | 'error' | 'pending'
isMigrationboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.