KYC Entities

The Entity API is the foundation of Reap’s compliance system. An entity represents a business or an individual that is undergoing verification. All compliance checks, KYC processes, and feature access permissions begin with creating and managing entities.

What is an Entity?

An entity can be one of two types:

• INDIVIDUAL — a person being verified (e.g., director, representative)
• BUSINESS — the company itself

Each entity is uniquely tied to a business (via businessId) and may have associated:

• Submitted requirements
• Enabled features
• KYC accounts (for individuals)

---

Supported Operations

Method	Endpoint	Description
POST	/entity	Create a new entity
GET	/entity	List all entities tied to a business
GET	/entity/{entityId}	Retrieve a specific entity’s details
DELETE	/entity/{entityId}	Permanently delete an entity

---

Common Use Cases

• Onboard a new director, owner, or business entity for compliance review
• Store and track submission of KYC requirements
• Retrieve submitted values, requirement status, or enabled features
• Clean up invalid or test entities with the DELETE endpoint

---

Requirements on Entity Creation

To create an entity, you must provide:

• externalId: your internal reference to the entity
• type: INDIVIDUAL or BUSINESS
• Optional: requirements[] — an array of slug/value pairs (e.g., company-name, country-of-incorporation)

Example request:

JSON

{
  "externalId": "user_12345",
  "type": "INDIVIDUAL",
  "requirements": [
    { "requirementSlug": "first-name", "value": "Jane" },
    { "requirementSlug": "last-name", "value": "Doe" }
  ]
}

---

Entity Details Response

A full entity record may include:

• id, externalId, type, businessId

• enabledFeatures[] (if approved)

• submittedRequirements[]:

  • requirement name + value
  • current status (PENDING, APPROVED, etc.)
  • timestamped createdAt and updatedAt

---

Deleting Entities

Use the DELETE /entity/{entityId} endpoint only when:

• You're removing test data
• The entity was created by mistake
• You are resetting the compliance flow

This operation is irreversible and should not be used for production clean-up without caution.

---

What’s Next?

After creating an entity, head to the KYC section to:

• Generate SDK tokens for identity verification
• Fetch or verify signed payloads for secure onboarding

Or proceed to submit requirements directly via POST /entity.