HUhub2
IRT

Retrieve a senders collection

Changed on

Returns your registered senders, most recent first, optionally filtered by state.

get/irt/v1/senders

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Query parameters

state'pending' | 'approved' | 'rejected' | 'disabled'
Example:approved

Restrict the result to the senders currently in this state.

pagenumber
Example:2

The page number in the returned data. The default value is 1. Do use with 'perPage' query parameter to paginate properly.

perPagenumber
Example:5

The maximum number of results that will be return. The default value is 10. Do use with 'page' query parameter to paginate properly.

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Hub2 identifier of the sender. Use it to reference the sender on a transaction.

externalIdstring required

Your own identifier for this sender, as supplied on creation.

payoutType'individual' | 'business' required

Type of sender identity carried by this record.

state'pending' | 'approved' | 'rejected' | 'disabled' required

Lifecycle state of the sender. Only approved senders may be used to initiate a transaction. pending senders await a Hub2 compliance review, rejected and disabled ones cannot transact.

stateReason'possible_match' | 'screening_incomplete' | 'kyc_incomplete' | 'sanctions_match' | 'compliance_block' nullable required

Why the sender is pending (possible_match, screening_incomplete, kyc_incomplete) or rejected (sanctions_match, compliance_block); null for approved and disabled senders. Hub2's decision, distinct from screening.reason, which is what the sanctions screening matched.

screeningobject

Outcome of the last sanctions screening of the current identity. Absent while none has completed on it — a sender pending with reason screening_incomplete.

createdAtstring required

Creation date of the sender, in ISO 8601 format.

updatedAtstring required

Date of the last update of the sender, in ISO 8601 format.

Example response

[
  {
    "id": "snd_V1StGXR8Z5jdHi6BmyT",
    "externalId": "MTO-SENDER-00123",
    "payoutType": "individual",
    "state": "approved",
    "kyc": {
      "payoutType": "individual",
      "firstName": "Aminata",
      "lastName": "Traoré",
      "contactPhone": "+2250747123456",
      "dateOfBirth": "1992-05-23",
      "nationality": "CI",
      "idDocument": {
        "expiryDate": "2025-12-31",
        "idNumber": "123456789",
        "idType": "passport",
        "issueDate": "2020-01-01",
        "issuer": "Ministry of Interior",
        "issuerCountry": "CI",
        "issuerPlace": "Abidjan",
        "otherIdDescription": "Custom identification document"
      },
      "name": "TikTok Inc.",
      "countryOfIncorporation": "US",
      "legalEntityType": "privately_owned_company",
      "registrationDate": "2012-01-25",
      "registrationNumber": "VAT1234567",
      "tradingCountry": "US",
      "tradingCity": "New York",
      "tradingStreet": "20 W 34th St",
      "tradingPostalCode": "10001",
      "natureOfBusiness": "retail_trade",
      "phoneNumber": "+15555551234",
      "email": "tiktok@payments.com"
    },
    "screening": {
      "decision": "ALLOW",
      "reason": "NO_MATCH",
      "screenedAt": "2026-08-07T09:15:00.000Z"
    },
    "createdAt": "2026-08-07T09:15:00.000Z",
    "updatedAt": "2026-08-07T09:15:00.000Z"
  }
]

Changes