API Documentation for Test Data Generators

Below you will find information about the available endpoints, including descriptions, parameters, and sample responses. All endpoints are limited to a maximum of 50 records per request and 20 requests per hour.

GET /api/generators/credit-card

Generates test credit card numbers. Parameters: `count` (default 5, max 50), `type` (card type, e.g. visa, mastercard). See `/api/generators/credit-card/providers` for available types, `exclude` (comma-separated list of card numbers to exclude).

Parameters: count: number (optional), type: string (optional), exclude: string (optional)

Sample response: { cardData: CreditCard[] }

GET /api/generators/credit-card/providers

Returns a list of available credit card providers. No parameters.

Parameters:

Sample response: { providers: string[] }

GET /api/generators/iban

Generates IBAN numbers. Parameters: `count` (default 5, max 50), `country` (country code, default PL). See `/api/generators/iban/rules` for available countries, `bankCode` (bank code, default '0001' or empty string if not required). Required if `bankCodeLength` is defined for given country, `exclude` (comma-separated list of IBANs to exclude).

Parameters: count: number (optional), country: string (optional), bankCode: string (optional), exclude: string (optional)

Sample response: { ibanList: string[] }

GET /api/generators/iban/rules

Returns a list of available IBAN rules for given countries. No parameters.

Parameters:

Sample response: { ibanRules: { countryCode: string, length: number, bbanType: string, bankCodeLength: number }[] }

GET /api/generators/lv-personal-id

Generates Latvian personal IDs. Parameters: `count` (default 5, max 100), `minAge` (default 21, allowed range 1-99), `maxAge` (default 45, allowed range 1-120), `format` (currently only `old` is available, default 'old'), `exclude` (comma-separated list of IDs to exclude).

Parameters: count: number (optional), minAge: number (optional), maxAge: number (optional), format: string (optional), exclude: string (optional)

Sample response: { personalIds: string[] }

GET /api/generators/pesel

Generates PESEL numbers. Parameters: `count` (default 5, max 1000), `yearFrom` (default 1980, allowed range 1900-2099), `yearTo` (default 2000, allowed range 1900-2099), `gender` (male/female/empty string for random), `exclude` (comma-separated list of PESEL numbers to exclude).

Parameters: count: number (optional), yearFrom: number (optional), yearTo: number (optional), gender: string (optional), exclude: string (optional)

Sample response: { peselList: string[] }

GET /api/validators/credit-card

Validates a credit card number using the Luhn algorithm. Parameters: `number` (card number, required), `type` (card type, required).

Parameters: number: string (required), type: string (required)

Sample response: { isValid: boolean }

GET /api/validators/iban

Validates an IBAN number. Parameter: `iban` (required).

Parameters: iban: string (required)

Sample response: { isValid: boolean }

GET /api/generators/swift-bic

Generates test SWIFT/BIC codes. Parameters: `country` (country code, required), `bank` (bank code, required), `branch` (branch code, optional). Use `/api/generators/swift-bic/options` to get available options.

Parameters: country: string (required), bank: string (required), branch: string (optional)

Sample response: { swiftBicData: {code: string}[] }

GET /api/generators/swift-bic/options

Returns a list of available countries, banks and branches. Parameters: `country` (country code, optional), `bank` (bank code, optional).

Parameters: country: string (optional), bank: string (optional)

Sample response: { countries: { code: string, name: string }[], banks: { code: string, name: string }[], branches: { code: string, name: string }[] }