> ## Documentation Index > Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Contact Requests in a Period of Time > This API allows you to fetch a complete list of contacts linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 records per page. ## OpenAPI ````yaml /api/openapi/v2-reference.yaml get /v2/contacts/all openapi: 3.0.2 info: title: Multi-currency Payment APIs description: >- ## Introduction The Multi-currency Payment API Solution provides developers with a unified API schema to support multiple currencies efficiently. These APIs enable seamless transactions for both payin and payout operations, ensuring a robust, reliable, and scalable payment infrastructure for businesses dealing with various currencies. ### Key Features - **Single API Schema**: A single schema supports all currencies in your account, simplifying integration and management. - **Payin and Payout Process**: - **Step 1**: Call the **Get payin method list** to retrieve the list of supported methods. - **Step 2**: Call the **Get payin required fields** to get specific required fields for each method. - **Step 3**: Create the payment using the method and required fields from the previous step. - **Step 4**: On the sandbox environment, you can call the **Simulate payin** to simulate the payment.
Please note: GST should only be set to true for AU Merchants for AUD currency only. For all other currencies, set GST to false.
This documentation provides detailed guidance for integrating these capabilities into your application. version: 2.0.0 termsOfService: https://helloclever.co/terms contact: email: support@helloclever.co servers: - url: https://api.cleverhub.co/api description: Sandbox Environment - url: https://api-merchant.helloclever.co/api description: Production Environment security: - app-id: [] secret-key: [] paths: /v2/contacts/all: get: tags: - Contact summary: Get Contact Requests in a Period of Time description: >- This API allows you to fetch a complete list of contacts linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 records per page. parameters: - name: from_date in: query schema: type: string description: >- Start date to query contact requests from, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone example: '2022-01-01T00:00:00' - name: to_date in: query schema: type: string description: >- End date to query contact requests, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. The datetime would be in UTC timezone example: '2022-01-01T00:00:00' - name: page in: query schema: type: string description: Page number to query. Currently we support 20 records per page. - name: per_page in: query schema: type: string description: Default 20 records per page. responses: '200': description: OK content: application/json: schema: type: object properties: per_page: type: integer page: type: integer total_page: type: integer records: type: array items: type: object required: - email - first_name - last_name - type - dob - reg_no - gender - phone - street - city - postal_code - state - country properties: email: type: string description: Contact's email first_name: type: string description: Contact's first name last_name: type: string description: Contact's last name type: type: string description: >- The type of contact (e.g., individual or organization) example: individual enum: - individual - organization dob: type: string description: Contact date of birth, format 'yyyy-mm-dd' phone: type: string description: Contact's phone number example: +61-412345678 reg_no: type: string description: Contact registration number. gender: type: string example: male description: Contact's gender enum: - male - female street: type: string description: The primary name of an address's street. city: type: string description: Name of an address's city or town. postal_code: type: string description: The address's postcode state: type: string description: The address's state / province / county. country: type: string description: ISO 3166-1 alpha-2 country code. identity: type: object required: - issue_country - document_number - issue_date - expiry_date - id_doc_type description: >- Contains the most recent KYC submission details for the contact. properties: issue_country: type: string description: ISO 3166-1 alpha-2 country code. id_doc_type: type: string description: Type of identification document enum: - passport - id_card - driving_license document_number: type: string description: ID document number issue_date: type: string description: Format 'yyyy-mm-dd' expiry_date: type: string description: Format 'yyyy-mm-dd' kyc_statuses: type: array description: >- An array of KYC statuses for the contact, containing multiple KYC instances with status and message. items: type: object properties: kyc_status: type: string description: >- - `pending`: KYC process has been initiated for the contact, but the verification is not yet completed. The contact is still in the process of submitting the necessary documents. - `failed`: contact was unable to verify the KYC documents due to invalid, incomplete, or unclear information. The contact may need to resubmit the documents. - `rejected`: KYC has been rejected for future transactions due to failure in meeting the required verification criteria. The contact cannot proceed with any further transactions until the issue is resolved. - `manual_review`: The KYC process is under review by the compliance team to approve or reject the documents. This status typically means that the submitted documents need further examination. - `blocked`: Contact's KYC has been blocked, preventing future transactions until further resolution. The block may be due to suspicious activity or a need for additional verification. - `approved`: Contact has successfully passed the KYC verification, and future transactions can proceed without issue. The contact's identity has been verified and is now compliant with the platform's standards. enum: - pending - failed - rejected - manual_review - blocked - approved message: type: string description: Message related to the KYC status example: total: 100 page: 1 per_page: 20 records: - email: test@example.com first_name: Luyx last_name: Tran type: individual dob: '1991-12-24' phone: '+6123224242' reg_no: '123456789' gender: male street: 338 George Street city: Sydney postal_code: '2000' state: New South Wales country: AU identity: issue_country: AU document_number: '12345678' issue_date: '2024-04-16' expiry_date: '2024-04-16' id_doc_type: Passport kyc_statuses: - kyc_status: approved message: 'null' - kyc_status: rejected message: KYC is rejected. '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: object properties: code: type: string message: type: string example: errors: code: BAD_REQUEST message: Invalid query parameters. '401': description: Unauthorized content: application/json: schema: type: object properties: errors: type: object properties: code: type: string message: type: string example: errors: code: REQUIRE_LOGIN message: Not Authorized components: securitySchemes: app-id: type: apiKey in: header name: app-id description: | A unique identifier assigned to each application. secret-key: type: apiKey in: header name: secret-key description: | A secure token associated with the `app-id`. ```` ## Related topics - [Get Payout Requests in a Period of Time](/api/payout/get-payout-requests-in-a-period-of-time.md) - [Get Customer Requests in a Period of Time](/api/customer/get-customer-requests-in-a-period-of-time.md) - [Get Payin Requests in a Period of Time](/api/payin/get-payin-requests-in-a-period-of-time.md)