Search Personal Profiles

This endpoint retrieves a paginated list of personal customer profiles from the Netevia platform based on one or more specified search filters. Partners and administrators can query by identity fields, address components, application status, or financial account identifiers. Results include full profile details covering account holder information, application status, and profile settings.

Endpoint

GET /netevia/searchPersonalProfiles

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint to look up personal customer profiles in administrative or operational workflows — for example, when a support agent needs to locate a customer by name or email, when verifying a customer's onboarding status, or when auditing profiles associated with a specific partner or employer. At least one filter parameter should be supplied to narrow results; omitting all filters returns up to the default page size of records.

Query Parameters

Parameter	Type	Required	Description
skip	integer (int32)	No	Number of records to skip for pagination. Default: `0`.
count	integer (int32)	No	Maximum number of records to return. Default: `20`.
firstName	string	No	Filter by customer first (given) name.
lastName	string	No	Filter by customer last (family) name.
email	string	No	Filter by customer email address.
city	string	No	Filter by city of residence.
state	integer (int32)	No	Filter by US state. Enum value (1–53) corresponding to American state codes.
zip	string	No	Filter by postal/ZIP code.
ssn	string	No	Filter by Social Security Number (format: `XXX-XX-XXXX`).
status	integer (int32)	No	Filter by bank application status. Enum: `0`=Default, `1`, `2`, `3`, `4`.
bankingStatus	string	No	Filter by banking application status. Enum: `New`, `Submitted`, `PendingUW`, `ApprovedUW`, `Closed`, `Cancelled`, `Pending_Review`, `Denied`, `Approved`, `Pending`, `InReview`, `AutoApprovedUW`.
agentId	integer (int32)	No	Filter profiles associated with a specific agent.
isoId	integer (int32)	No	Filter profiles associated with a specific ISO.
last4	string	No	Filter by last 4 digits of a payment card.
partnerId	integer (int32)	No	Filter profiles belonging to a specific partner.
userId	integer (int32)	No	Filter by the platform user ID.
employerId	integer (int32)	No	Filter profiles associated with a specific employer.
finAccountNumber	integer (int64)	No	Filter by financial account number.

Response

200 OK

Field	Type	Description
totalCount	integer	Total number of records matching the search criteria.
errorMessage	string or null	Error message if a partial failure occurred; otherwise null.
cursor	string or null	Pagination cursor for fetching the next page of results.
records	array	List of personal profile objects matching the search criteria.
records[].id	integer	Internal profile record ID.
records[].createdDate	string (date-time)	Date and time the profile was created.
records[].updatedDate	string (date-time) or null	Date and time the profile was last updated.
records[].userProfileId	integer	Associated user profile ID.
records[].step	integer	Current onboarding step. Enum: `0`–`4`.
records[].accountHolderInformation	object	Personal information of the account holder (see below).
records[].accountHolderInformation.id	integer	Record ID for the personal information entry.
records[].accountHolderInformation.createdDate	string (date-time)	Creation timestamp.
records[].accountHolderInformation.updatedDate	string (date-time) or null	Last update timestamp.
records[].accountHolderInformation.email	string or null	Account holder's email address.
records[].accountHolderInformation.givenName	string or null	Account holder's first name.
records[].accountHolderInformation.familyName	string or null	Account holder's last name.
records[].accountHolderInformation.middleName	string or null	Account holder's middle name.
records[].accountHolderInformation.phone	string or null	Account holder's phone number.
records[].accountHolderInformation.ssn	string or null	Account holder's SSN (masked as `XXX-XX-XXXX` in display).
records[].accountHolderInformation.dateOfBirth	string (date-time) or null	Account holder's date of birth.
records[].accountHolderInformation.streetAddress	string or null	Street address (read-only).
records[].accountHolderInformation.extendedAddress	string or null	Apartment, suite, or unit (read-only).
records[].accountHolderInformation.postalCode	string or null	ZIP/postal code (read-only).
records[].accountHolderInformation.locality	string or null	City (read-only).
records[].accountHolderInformation.state	integer	State enum value (read-only).
records[].accountHolderInformation.countryCodeAlpha3	string or null	ISO 3-letter country code (read-only).
records[].businessAccountHolder	object or null	Business account holder details, if applicable.
records[].isSubmitted	boolean or null	Whether the profile application has been submitted.
records[].accountHolderId	string or null	External account holder identifier.
records[].nickName	string or null	Customer's display nickname.
records[].cardProductId	string or null	Assigned card product identifier.
records[].openApplicationId	string or null	Open application identifier.
records[].financialAccountId	string or null	Primary financial account identifier.
records[].applicationStatus	integer	Bank application status enum (0–4).
records[].bankingStatus	string	Banking application status string.
records[].applicationDate	string (date-time) or null	Date the application was submitted.
records[].approvalDate	string (date-time) or null	Date the application was approved.
records[].isDeleted	boolean	Whether the profile has been soft-deleted.
records[].isLocked	boolean	Whether the profile is locked.
records[].isAccessLocked	boolean	Whether login access is locked (e.g., after multiple failed login attempts).
records[].isMfaEnabled	boolean	Whether multi-factor authentication is enabled.
records[].isOtpEnabled	boolean	Whether one-time password authentication is enabled.
records[].agentPayoutProfileId	integer or null	Associated agent payout profile ID.
records[].salesRepresentativeId	integer or null	Associated sales representative ID.
records[].rewordType	integer	Reward type enum: `1`, `2`, or `4`.
records[].isNew	boolean or null	Whether the profile is newly created.
records[].isExceptional	boolean or null	Whether the profile has been flagged as exceptional.
records[].profileSettings	object or null	Profile-level settings including account limits.
records[].profileSettings.financialAccountsPermissions.financialAccountsMaxNumber	integer	Maximum number of financial accounts allowed.
records[].profileSettings.financialAccountsPermissions.externalAccountsMaxNumber	integer	Maximum number of external accounts allowed.
records[].profileSettings.transferAmountLimits.achOutTransferAmountLimit	integer or null	ACH outbound transfer limit.
records[].profileSettings.transferAmountLimits.internalTransferAmountLimit	integer or null	Internal transfer limit.
records[].profileSettings.loanOff	boolean	Whether loan features are disabled for this profile.
records[].applicationCreationType	string	Channel through which the application was created. Enum: `MobileApplication`, `OnlineBankingApplication`, `OnlineMerchantApplication`, `NeteviaBoardingApplication`, `BankingAPI`, `NeteviaAPI`.
records[].exceptionalTemplateId	integer or null	ID of the exceptional template applied to the profile.
records[].profileType	integer	Profile type enum: `0`, `1`, `2`, `3`.
records[].accountType	integer	Account type enum: `1`–`5`.
records[].employer	object or null	Employer details if the profile is linked to an employer.
records[].employer.id	integer	Employer record ID.
records[].employer.name	string or null	Employer name.
records[].employer.enabled	boolean	Whether the employer is active.
records[].employer.date	string (date-time)	Employer record date.
records[].lockFinancialAccountId	string or null	Financial account ID used for locking purposes.
records[].agreements	array or null	List of agreements accepted by the account holder.
records[].agreements[].name	string or null	Agreement name.
records[].agreements[].createdDate	string (date-time)	Date the agreement was created.
records[].agreements[].acceptanceDate	string (date-time) or null	Date the customer accepted the agreement.

{
  "totalCount": 2,
  "errorMessage": null,
  "cursor": null,
  "records": [
    {
      "id": 1042,
      "createdDate": "2024-03-15T10:22:00Z",
      "updatedDate": "2024-05-01T08:45:00Z",
      "userProfileId": 8801,
      "step": 4,
      "accountHolderInformation": {
        "id": 2201,
        "createdDate": "2024-03-15T10:22:00Z",
        "updatedDate": "2024-05-01T08:45:00Z",
        "email": "[email protected]",
        "givenName": "Jane",
        "familyName": "Doe",
        "middleName": null,
        "phone": "+13055550101",
        "ssn": "XXX-XX-XXXX",
        "dateOfBirth": "1990-07-22T00:00:00Z",
        "streetAddress": "456 Oak Avenue",
        "extendedAddress": "Apt 3B",
        "postalCode": "33101",
        "locality": "Miami",
        "state": 9,
        "countryCodeAlpha3": "USA"
      },
      "businessAccountHolder": null,
      "isSubmitted": true,
      "accountHolderId": "AH-88901",
      "nickName": "JDoe",
      "cardProductId": "CP-001",
      "openApplicationId": null,
      "financialAccountId": "FA-XXXXXXXXXX",
      "applicationStatus": 2,
      "bankingStatus": "Approved",
      "applicationDate": "2024-03-15T10:30:00Z",
      "approvalDate": "2024-03-16T09:00:00Z",
      "isDeleted": false,
      "isLocked": false,
      "isAccessLocked": false,
      "isMfaEnabled": true,
      "isOtpEnabled": false,
      "agentPayoutProfileId": null,
      "salesRepresentativeId": 55,
      "rewordType": 1,
      "isNew": false,
      "isExceptional": false,
      "profileSettings": {
        "financialAccountsPermissions": {
          "financialAccountsMaxNumber": 5,
          "externalAccountsMaxNumber": 3
        },
        "transferAmountLimits": {
          "achOutTransferAmountLimit": 10000,
          "internalTransferAmountLimit": 25000
        },
        "loanOff": false
      },
      "applicationCreationType": "BankingAPI",
      "exceptionalTemplateId": null,
      "profileType": 1,
      "accountType": 1,
      "employer": null,
      "lockFinancialAccountId": null,
      "agreements": [
        {
          "name": "Terms of Service",
          "createdDate": "2024-01-01T00:00:00Z",
          "acceptanceDate": "2024-03-15T10:25:00Z"
        }
      ]
    }
  ]
}

Error Codes

Code	When it happens
400	Missing required fields or validation error
401	Token missing, expired, or invalid
403	Insufficient permissions
404	Resource not found
500	Internal server error

Common Mistakes

Passing ssn as a plain number instead of a formatted string (XXX-XX-XXXX); the field expects a string value.
Omitting all query parameters, which returns a large unfiltered result set and may impact performance; always supply at least one filter.
Using skip and count without accounting for totalCount — always check totalCount to determine whether additional pages exist.
Providing a state value as a two-letter abbreviation (e.g., "FL") instead of the integer enum value (e.g., 9).
Confusing status (integer enum for bank application status) with bankingStatus (string enum for banking application status) — both are separate fields with different types.

Related Endpoints

GET /netevia/searchBusinessProfiles — Search business customer profiles using similar filter criteria
GET /netevia/getPersonalProfile/{id} — Retrieve a single personal profile by its ID
POST /netevia/createPersonalProfile — Create a new personal customer profile
PUT /netevia/updatePersonalProfile/{id} — Update an existing personal customer profile

Example

curl -X GET "https://api.banking.netevia.dev/netevia/searchPersonalProfiles?firstName=Jane&lastName=Doe&bankingStatus=Approved&skip=0&count=20" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"