Onboarding: Get Details

GET

https://aws-verification-id-dev.rillis.io/api/v1/client-api/onboardings/{id}

Allows you to retrieve the details of an onboarding process, whether for an individual or a company. This endpoint provides comprehensive information about the onboarding step, which is a specific stage within an onboarding flow. The request requires an identifier (id) to locate the onboarding record. The response includes a detailed object with all the relevant data for that onboarding instance, enabling you to manage, validate, or display the onboarding status and related details.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://aws-verification-id-dev.rillis.io/api/v1/client-api/onboardings/' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "_id": "67ead05f66d86f9778eaa150",
  "flow": "67cf079a0ebe7c5442de4a23",
  "user": "64204dd759290a9403fef44e",
  "flow_instance": "67eab94e66d86f9778eaa0d7",
  "flow_event": "67ead05f66d86f9778eaa14e",
  "identities": [],
  "data": {
    "data_individual": {
      "address_1": "AV 5 Calle x 2",
      "address_2": "AV 8 Calle 33 2",
      "city": "Colorado",
      "country_of_residence": "USA",
      "name": "name person 2",
      "province": "El caio 2",
      "business_information": {
        "estimated_monthly_transaction_usd": 70000.3,
        "fund_origin": "SALARY",
        "funding_source_type": "INHERITANCE",
        "income_brief_description": "description individual income",
        "legal_relationship_purpose": "COMMERCIAL_OPERATIONS",
        "monthly_income_usd": 7000000,
        "total_assets": 8888888,
        "source_of_income": "SALARY_OR_WAGE"
      },
      "email": "fff@gmail.com",
      "is_pep": true
    },
    "type": "INDIVIDUAL"
  },
  "status": "PENDING_REVIEW",
  "file_references_data": [],
  "completed_at": "2025-03-31T17:26:56.869Z",
  "reason": null,
  "createdAt": "2025-03-31T17:26:55.374Z",
  "updatedAt": "2025-03-31T17:26:56.877Z"
}

Modified at 2025-05-29 15:11:50

Identity: Update Status

Onboarding: Get File