AcuCheck API Field Formats

Strings

Many string fields returned by the AcuCheck API, such as customer names, email addresses, and financial institution names, are reported exactly as provided by the client or stored in the system. While the API does not impose strict length limits, it is recommended that fields such as customer names and addresses be stored with reasonable length allocations (e.g., 255 characters for a name field). For sensitive data like Social Security Numbers or bank account numbers, AcuCheck advises storing only masked values (e.g., the last four digits), ensuring data privacy and compliance while maintaining data integrity.

Numbers and money

Numeric fields in the AcuCheck API, including monetary amounts and account balances, are typically returned as floating-point values. When dealing with money, the API adheres to the standard of providing two decimal places for precision. For instance, a field like balanceAmount will be represented as 1000.50 to indicate $1,000.50. Currency codes are also used alongside the monetary values to specify the type of currency (e.g., USD for U.S. dollars, EUR for Euros).

Dates

Date fields in the AcuCheck API are returned in ISO 8601 format (e.g., 2025-08-14T15:39:46.487Z). This format includes both the date and time, with a precision down to milliseconds. For consistency, all date-time data follows this format, which ensures compatibility across different systems and platforms.

Datetimes

Datetime fields are represented in the same ISO 8601 format as Date fields but may include more detailed timestamps. For example, fields related to transaction dates or customer registration times will use this precise format, ensuring that operations based on time are accurate and reliable across different time zones.

Enums

AcuCheck API uses enums to represent predefined sets of values. For example, customer types are represented using integer values, where:
  1. indicates an "Individual Customer" and
  2. denotes a "Business Customer".
Similarly, statuses like report request status are also represented with enums, with values such as:
  1. for "Pending" and
  2. for "Completed".

Identifiers

Identifying fields in the AcuCheck API, such as customer IDs, report IDs, and transaction IDs, are returned as unique identifiers (UUIDs). These identifiers are essential for referencing specific records and ensuring that each request or transaction is accurately processed.

Phone Numbers

Phone number fields in the AcuCheck API are typically stored and returned in a standardized format that includes country code and the phone number itself. For example, phone numbers are expected to follow the international format, such as +1-234-567-8901 for U.S. numbers. This ensures consistency and avoids ambiguity, especially when dealing with international clients.

Email Addresses

Email fields in the AcuCheck API should follow the standard email format, such as user@example.com. While the API doesn't impose strict length restrictions, it is good practice to store emails within a reasonable length (e.g., up to 254 characters) as per email address standards.

Social Security Numbers (SSN) and Bank Account Numbers

Sensitive information like Social Security Numbers (SSN) or bank account numbers in the AcuCheck API are returned in a masked format. For SSNs, only the last four digits are shown (e.g., ******1234), and for bank account numbers, similar masking (e.g., ******5678) is applied to ensure data privacy and security.

Addresses

Fields related to customer addresses, such as addressLine1, addressLine2, city, state, postalCode, and country, are returned as string values. The API may also validate address components based on predefined formats to ensure correct data entry. For example, postal codes are often limited to 10 characters to match global standards, and country codes must align with international standards (e.g., "US" for the United States, "IN" for India).

Bank Routing Numbers

Bank routing numbers are returned as a 9-digit numeric value (e.g., 011000015). This ensures compliance with U.S. financial institutions' routing number formats. The API may validate these numbers to ensure they match established banking patterns.

Financial Amounts and Currency Codes

The API returns financial amounts with the appropriate precision (up to two decimal places). Currency values are returned alongside currency codes (e.g., USD for U.S. dollars, EUR for Euros), and the currencyCode field will specify the type of currency used. This ensures that amounts are correctly interpreted in different global contexts.

Boolean Flags

For various flags such as isActive or isVerified, the AcuCheck API returns boolean values (true or false). These are used to indicate binary states (e.g., whether a customer is active or not, or if an email verification process is completed).

Custom Fields

Some fields might have custom data types specific to AcuCheck's business logic, such as triggerReportRequest (a boolean flag indicating if a report generation has been triggered for a customer), which helps automate financial report creation. These fields ensure smooth integration into financial analysis processes.

Transaction Details

For transaction-related fields, such as transactionId, amount, and currencyCode, the AcuCheck API ensures proper handling of numeric values (for amounts) and adheres to standardized formats for financial transactions. The transactionId field uses unique identifiers (UUIDs) for each transaction to ensure accuracy and traceability.