Onboarding Pending

The Onboarding Pending API allows you to retrieve a paginated list of customers who are pending onboarding for transaction monitoring. Use this endpoint to track customer verification status and manage the onboarding pipeline.

API Endpoint

GET {base_url}/transactions/monitoring/onboarding-pending

Request Format

This endpoint accepts a GET request with query parameters for pagination.

Request Headers

Authorization: Bearer {token}

Query Parameters

Parameter	Type	Required	Default	Description
page	number	No	1	Page number (must be greater than 0)
pageSize	number	No	10	Number of items per page (1–100)

Example Request URL

GET {base_url}/transactions/monitoring/onboarding-pending?page=1&pageSize=10

Response Format

{
  "version": null,
  "statusCode": 200,
  "messages": ["Processed successfully"],
  "result": {
    "data": [
      {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "firstName": "John",
        "lastName": "Doe",
        "onboardingStatus": "Pending",
        "onboardedBy": "officer@example.com",
        "accountStatus": "Active",
        "accountCount": 1,
        "customerName": "John Doe",
        "createdAt": "2025-03-15T10:30:00Z",
        "customerLeanConnectionId": "conn_abc123"
      }
    ],
    "page": 1,
    "pageSize": 10,
    "totalCount": 45,
    "filters": null,
    "totalPages": 5,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "message": null,
    "unreadLogsCount": 0
  }
}

Response Fields

Field	Type	Description
version	string	API version (nullable)
statusCode	number	HTTP status code
messages	string[]	Response messages
result.data	array	List of customer onboarding records
result.data[].id	string	Unique customer identifier
result.data[].firstName	string	Customer's first name
result.data[].lastName	string	Customer's last name
result.data[].onboardingStatus	string	Current onboarding status (see values below)
result.data[].onboardedBy	string	Officer who initiated the onboarding
result.data[].accountStatus	string	Account status — Active or Inactive
result.data[].accountCount	number	Number of accounts associated with the customer (default: 0)
result.data[].customerName	string	Computed full name (firstName + lastName)
result.data[].createdAt	string	ISO 8601 timestamp of when the record was created
result.data[].customerLeanConnectionId	string	Lean banking connection identifier
result.page	number	Current page number
result.pageSize	number	Number of items per page
result.totalCount	number	Total number of matching records
result.filters	object	Applied filters (nullable)
result.totalPages	number	Computed total pages (ceil(totalCount / pageSize))
result.hasNextPage	boolean	true if page < totalPages
result.hasPreviousPage	boolean	true if page > 1
result.message	string	Additional message (nullable)
result.unreadLogsCount	number	Count of unread log entries

Onboarding Status Values

Status	Description
Verified	Customer has completed verification
Pending	Verification is in progress
Invited	Invitation has been sent
EmailSent	Verification email sent
EmailChanged	Customer changed their email
NotVerified	Customer has not completed verification
NoMailSent	No invitation email has been sent yet
LinkExpired	The verification link has expired

Example Usage

cURL Example

curl -X GET \
  '{base_url}/transactions/monitoring/onboarding-pending?page=1&pageSize=10' \
  -H 'Authorization: Bearer your_token_here'

Error Handling

Status Code	Description	Solution
400	Invalid pagination parameters	Ensure page > 0 and pageSize is between 1 and 100
401	Unauthorized	Verify your authentication token
403	Forbidden	Check that your account has the required permissions
500	Internal server error	Contact support with the error details

Related Resources

• Add User — Register an individual for transaction monitoring
• Add Company — Register a company for transaction monitoring
• Customer Details — Retrieve the full profile of a specific customer