IdentityEntity

Get entity compliance

Retrieve a list of fields that are not yet populated on an entity based on the compliance requirements for your program. Column will work with you to define required fields given your specific use case.

get/entities/{entity_id}/compliance

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/entities/{entity_id}/compliance
  • Auth: HTTP basic

Path parameters

entity_idstring required

Response

Successful response

entity_idstring required

The unique ID of the entity.

fieldsobject required

Map of field path (e.g. address.line_1, evidence.proof_of_address) to its status: complete, missing, invalid, or pending.

updated_atstring date-time required

The timestamp at which the entity's compliance status was last evaluated.

Changes

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