Usage Info

This method returns all stored information about a Subject Record entity, including business, bank accounts, persons and workflows. Sensitive information like tax ID are masked by default and revealed only when specifically requested. Use this method when displaying person profiles, populating forms with existing data, or retrieving specific attributes for compliance verification.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The identifier for the Subject Record to get details about.
show_sensitive_data	boolean	No	A boolean value that if `true`, indicates that sensitive data should shown. If the parameter is not provided, the value defaults to `false` and the sensitive data will be masked. The sensitive data for the Subject Record is dependent on the sub-entities bank accounts, persons, etc.
verbose	boolean	No	A boolean value that when `true` includes the sub-entities of the subject record in the response. The sub-entities are bank accounts, persons, workflows and business.

Example

{
  "subject_record_id": "sr_4PYsekjAX8VMuAOfmW81C7",
  "show_sensitive_data": true,
  "verbose": true,
}

Response

Data

Parameter	Type	Description
Subject Record	object	The Subject Record parameter is defined in the tables below.

Subject Record Parameters

Parameter	Type	Description
subject_record_id	string	The subject record Id.
subject_record_type	string	The subject record type. Must be one of SUBJECT_RECORD_TYPES .
bank_accounts	array of objects	A list containing the bank accounts that belongs to the subject record. Requires verbose to be `true` to be displayed.
business	object	An object containing the business information that belongs to the subject record. Requires verbose to be `true` to be displayed.
persons	array of objects	A list containing the persons information that belongs to the subject record. Requires verbose to be `true` to be displayed.
workflows	object	An object containing the workflows that subject record belongs to. Requires verbose to be `true` to be displayed.
created_at	string	The date-time when the Subject Record was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Subject Record was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Examples

Example without verbose

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_3P0QaPzjXxFDUqn0F0BH3a"
  },
  "data": {
    "subject_record": {
      "subject_record_id": "sr_400UEI1TODyvrAEZLUzSWu",
      "subject_record_type": "BUSINESS",
      "created_at": "2025-08-22T15:25:37.687Z",
      "updated_at": "2025-08-22T15:25:37.687Z"
    }
  }
}

Example with verbose and show sensitive data

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_7VG7Ui6Wk4GVfg1t5Sdest"
  },
  "data": {
    "subject_record": {
      "subject_record_id": "sr_400UEI1TODyvrAEZLUzSWu",
      "subject_record_type": "BUSINESS",
      "created_at": "2025-08-22T15:25:37.687Z",
      "updated_at": "2025-08-22T15:25:37.687Z",
      "bank_accounts": [
        {
          "bank_account_id": "ba_6VQh2bQYyFDSFRvx4eoKTl",
          "bank_account_ownership_type": "business",
          "bank_account_type": "general_ledger",
          "bank_routing_number": "021000021",
          "bank_account_number": "1234567819",
          "bank_name": "Chase Bank",
          "created_at": "2025-08-22T15:25:53.986Z",
          "updated_at": "2025-08-22T15:25:53.986Z"
        }
      ],
      "business": {
        "business_id": "b_2fyRidkcpm0P1RC8xs7tA2",
        "operating_name": "Rockout Pay",
        "legal_name": "Rockout Pay LLC",
        "registration_type": "GOVERNMENT",
        "established_date": "1990-03-30",
        "tax_id": "834567890",
        "phone_number": "8888888888",
        "addresses": [
          {
            "type": "LEGAL",
            "line1": "1234 INNOVATION DRIVE",
            "line2": "SUITE 500",
            "city": "AUSTIN",
            "state": "TX",
            "postal_code": "78701",
            "country": "US"
          },
          {
            "type": "MAILING",
            "line1": "1234 INNOVATION DRIVE",
            "line2": "SUITE 500",
            "city": "AUSTIN",
            "state": "TX",
            "postal_code": "78701",
            "country": "US"
          }
        ],
        "industry_category_codes": [
          {
            "type": "MCC",
            "code": "5734",
            "details": {
              "mcc_details": {
                "card_brand": "MASTERCARD"
              }
            }
          }
        ],
        "website": "https://www.rockoutpay.com",
        "social_networks": [
          {
            "network": "YOUTUBE",
            "url": "https://www.twitter.com/company/rockoutpay"
          },
          {
            "network": "FACEBOOK",
            "url": "https://www.facebook.com/RockoutPay"
          },
          {
            "network": "LINKEDIN",
            "url": "https://www.linkedin.com/company/rockoutpay"
          }
        ],
        "business_description": "Technology solutions provider specializing in cloud infrastructure and IoT applications",
        "additional_fields": [
          {
            "field": "custom_field_1",
            "value": "Some string value"
          },
          {
            "field": "custom_field_2",
            "value": 12345
          },
          {
            "field": "custom_field_3",
            "value": "2024-06-24"
          },
          {
            "field": "custom_field_4",
            "value": true
          },
          {
            "field": "custom_field_5",
            "value": "OPTION_2"
          }
        ],
        "created_at": "2025-08-22T15:26:05.480Z",
        "updated_at": "2025-08-22T15:26:05.480Z"
      },
      "persons": [
        {
          "person_id": "p_6hvHyQZzjxsohfRFdU6Cng",
          "email": "[email protected]",
          "first_name": "John",
          "last_name": "Smith",
          "date_of_birth": "1990-10-10",
          "tax_id": "999999999",
          "citizenship": "US",
          "phone_number": "2345678901",
          "addresses": [
            {
              "type": "PRIMARY_RESIDENCE",
              "line1": "123 MAPLE AVENUE",
              "line2": "APARTMENT 4B",
              "city": "PORTLAND",
              "state": "OR",
              "postal_code": "97204",
              "country": "US"
            }
          ],
          "created_at": "2025-08-22T15:25:57.209Z",
          "updated_at": "2025-08-22T15:25:57.209Z"
        }
      ],
      "workflows": [
        {
          "workflow_id": "w_4PueCCL0bskdf3EXhiLqxB",
          "state": "STARTED",
          "subject_record_id": "sr_400UEI1TODyvrAEZLUzSWu",
          "created_at": "2025-08-22T15:26:05.491Z",
          "updated_at": "2025-08-22T15:26:05.491Z",
          "type": "BUSINESS_APPLICATION"
        }
      ]
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `subject_record_id` provided does not exist.