API Documentation
\nThis documentation is intended to help the API integration and facilitate the onboarding of customers between OZ Cambio and their partners.
\nAvailable resources
\nThere are currently the following features below that you can manipulate via the POST method:
\nAuthentication (Token)
\nCreate a Company Client [PJ]
\nCreate an Individual Client [PF]
\nAny questions during the implementation, we are at your disposal via email: fx@ozcambio.com.br.
\nYour suggestions and feedback for improvements are also very welcome!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20949677","collectionId":"fc60c370-eeb5-4813-915c-3b4551730151","publishedId":"2sAYBbcnyM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-05T13:27:35.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authenticate","id":"aa992770-445b-431f-861f-6aa4aa0219d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"testuser\",\r\n \"password\": \"Test@123\",\r\n \"rememberMe\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/{{API_VERSION}}/partner/public/authenticate","description":"Authenticates a user and returns a JWT token if the credentials are valid.
\n[Headers]
• Content-Type: application/json
[Request Body]
• Type: application/json
Example:
\n{\n \"username\": \"exampleUser\",\n \"password\": \"examplePassword\",\n \"rememberMe\": true\n}\n\nRequest Body Properties:
• username (string, required): The username of the user. Must be between 1 and 50 characters.
• password (string, required): The password of the user. Must be between 4 and 100 characters.
• rememberMe (bool, required): Indicates whether the user should be remembered for a longer period.
Responses:
• 200 OK: Authentication successful. Returns a JWT token.
Example:
\n{\n \"id_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\nNotes:
\n• Ensure that the username and password fields are correctly provided in the request body.
• The rememberMe field is a boolean that determines if the session should be extended.
Bearer Token
\n","_postman_id":"da1b1ba2-a1ef-490b-80fe-4da8ed31343f"},{"name":"Client PJ","item":[{"name":"Create User","id":"e3d7509d-7886-4e00-b0fa-3c0e04a54a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientType\": 1,\r\n \"additionalEmails\": [\r\n {\r\n \"email\": \"cruz@gmail.com\"\r\n }\r\n ],\r\n \"document\": \"27917519000195\",\r\n \"name\": \"Vinicius Goncalves Soares Cruz\",\r\n \"phoneNumber\": \"11975612895\",\r\n \"email\": \"cruz@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/{{API_VERSION}}/v1/partner/public/clients/create-pj","description":"Registers a new corporate client (PJ) with the provided data.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Body]
• Type: application/json
Example:
\n{\n \"document\": \"12.345.678/0001-99\", // Corporate Document Number (CNPJ)\n \"name\": \"John Doe\", // Contact Name in the Company\n \"phoneNumber\": \"123-456-7890\", // Contact Phone Number\n \"email\": \"john.doe@example.com\", // Contact Email Address\n \"additionalEmails\": [ // List of Additional Contact Emails\n {\n \"email\": \"additional1@example.com\"\n },\n {\n \"email\": \"additional2@example.com\"\n }\n ]\n}\n\nRequest Body Properties:
• document (string, required): Corporate Document Number (CNPJ)
• name (string, required): Contact Name in the Company
• phoneNumber (string, required): Contact Phone Number
• email (string, required): Contact Email Address
• additionalEmails (array of objects, optional): List of Additional Contact Emails
• email (string, required): Additional Contact Email
Responses:
• 200 OK: Corporate client registered successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"document\": \"12.345.678/0001-99\",\n \"name\": \"John Doe\",\n \"phoneNumber\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"additionalEmails\": [\n {\n \"email\": \"additional1@example.com\"\n },\n {\n \"email\": \"additional2@example.com\"\n }\n ]\n },\n \"message\": \"Corporate client registered successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The document field must be a valid Brazilian CNPJ number.
• The name, phoneNumber, and email fields are required and must be provided in the request body.
Updates the basic data of a corporate client (PJ) with the provided data.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Body]
• Type: application/json
Example:
\n{\n \"id\": 1, // Unique identifier of the corporate account\n \"document\": \"12.345.678/0001-99\", // Corporate Document Number (CNPJ)\n \"companyName\": \"Example Company\", // Company Name\n \"email\": \"contact@example.com\", // Corporate Email Address\n \"phone\": \"123-456-7890\", // Corporate Phone Number\n \"businessSector\": \"Technology\", // Business Sector\n \"postalCode\": \"12345-678\", // Postal Code\n \"address\": \"123 Main St\", // Address\n \"number\": \"456\", // Address Number\n \"complement\": \"Suite 789\", // Address Complement\n \"district\": \"Downtown\", // District\n \"city\": \"Example City\", // City\n \"state\": \"EX\" // State\n}\n\nRequest Body Properties:
• id (long, required): Unique identifier of the corporate account
• document (string, required): Corporate Document Number (CNPJ)
• companyName (string, required): Company Name
• email (string, required): Corporate Email Address
• phone (string, required): Corporate Phone Number
• businessSector (string, required): Business Sector
• postalCode (string, required): Postal Code
• address (string, required): Address
• number (string, required): Address Number
• complement (string, optional): Address Complement
• district (string, required): District
• city (string, required): City
• state (string, required): State
Responses:
• 200 OK: Basic data of the corporate client updated successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"document\": \"12.345.678/0001-99\",\n \"companyName\": \"Example Company\",\n \"email\": \"contact@example.com\",\n \"phone\": \"123-456-7890\",\n \"businessSector\": \"Technology\",\n \"postalCode\": \"12345-678\",\n \"address\": \"123 Main St\",\n \"number\": \"456\",\n \"complement\": \"Suite 789\",\n \"district\": \"Downtown\",\n \"city\": \"Example City\",\n \"state\": \"EX\"\n },\n \"message\": \"Basic data of the corporate client updated successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The document field must be a valid Brazilian CNPJ number.
• The id, document, companyName, email, phone, businessSector, postalCode, address, number, district, city, and state fields are required and must be provided in the request body.
Retrieves the data of the responsibles of a corporate client (PJ) by the client ID.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Path Parameters]
• id (long, required): The unique identifier of the corporate client (PJ).
Responses:
• 200 OK: Responsibles data retrieved successfully.
Example:
\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"document\": \"12345678901\",\n \"participation\": 50.0,\n \"canSign\": true,\n \"phone\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Anytown\",\n \"state\": \"Anystate\",\n \"zipCode\": \"12345\",\n \"country\": \"USA\"\n },\n \"isFATCA\": false,\n \"foreignAccountData\": null,\n \"corporateAccountId\": 1001\n },\n {\n \"id\": 2,\n \"name\": \"Jane Smith\",\n \"document\": \"98765432109\",\n \"participation\": 50.0,\n \"canSign\": false,\n \"phone\": \"987-654-3210\",\n \"email\": \"jane.smith@example.com\",\n \"address\": {\n \"street\": \"456 Elm St\",\n \"city\": \"Othertown\",\n \"state\": \"Otherstate\",\n \"zipCode\": \"67890\",\n \"country\": \"USA\"\n },\n \"isFATCA\": true,\n \"foreignAccountData\": {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"Foreign Bank\",\n \"country\": \"Foreign Country\"\n },\n \"corporateAccountId\": 1001\n }\n ],\n \"message\": \"Responsibles data retrieved successfully.\"\n}\n\nResponse Body Properties:
• success (boolean): Indicates if the request was successful.
• data (array of objects): List of responsibles data.
• id (long): Unique identifier of the responsible.
• name (string): Name of the responsible.
• document (string): Document of the responsible (CPF/CNPJ).
• participation (float): Percentage participation of the responsible in the company.
• canSign (boolean): Indicates if the responsible can sign on behalf of the company.
• phone (string, optional): Contact phone number of the responsible.
• email (string, optional): Contact email of the responsible.
• address (object, optional): Address of the responsible.
• street (string): Street address.
• city (string): City.
• state (string): State.
• zipCode (string): Zip code.
• country (string): Country.
• isFATCA (boolean): Indicates if the responsible is subject to FATCA regulations.
• foreignAccountData (object, optional): Foreign account data of the responsible, if applicable.
• accountNumber (string): Account number.
• bankName (string): Bank name.
• country (string): Country.
• corporateAccountId (long, optional): Identifier of the corporate account associated with the responsible.
• message (string): Response message.
• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\n• 404 Not Found: No responsible found with the provided client ID.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Client not found.\"\n}\n\nNotes:
• The id parameter in the URL is required to identify the corporate client.
Updates the data of the corporate client (PJ) responsibles with the provided data.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Body]
• Type: application/json
Example:
\n[\n {\n \"id\": 1, // Unique identifier of the company responsible\n \"name\": \"John Doe\", // Name of the company responsible\n \"document\": \"123.456.789-00\", // Document of the responsible (CPF/CNPJ)\n \"participation\": 50.0, // Percentage participation of the responsible in the company\n \"canSign\": true, // Indicates if the responsible can sign for the company\n \"phone\": \"123-456-7890\", // Contact phone of the responsible\n \"email\": \"john.doe@example.com\", // Contact email of the responsible\n \"address\": {\n \"street\": \"123 Main St\", // Street address of the responsible\n \"number\": \"456\", // Address number\n \"complement\": \"Apt 789\", // Address complement\n \"district\": \"Downtown\", // District\n \"city\": \"Example City\", // City\n \"state\": \"EX\", // State\n \"postalCode\": \"12345-678\" // Postal code\n },\n \"isFATCA\": false, // Indicates if the responsible is subject to FATCA regulations\n \"foreignAccountData\": {\n \"bankName\": \"Example Bank\", // Name of the foreign bank\n \"accountNumber\": \"123456789\", // Foreign account number\n \"country\": \"USA\" // Country of the foreign account\n },\n \"corporateAccountId\": 1 // Identifier of the corporate account associated with the responsible\n }\n]\n\nRequest Body Properties:
• id (long, required): Unique identifier of the company responsible
• name (string, required): Name of the company responsible
• document (string, required): Document of the responsible (CPF/CNPJ)
• participation (float, required): Percentage participation of the responsible in the company
• canSign (bool, required): Indicates if the responsible can sign for the company
• phone (string, optional): Contact phone of the responsible
• email (string, optional): Contact email of the responsible
• address (object, optional): Address of the responsible
• street (string, required): Street address of the responsible
• number (string, required): Address number
• complement (string, optional): Address complement
• district (string, required): District
• city (string, required): City
• state (string, required): State
• postalCode (string, required): Postal code
• isFATCA (bool, required): Indicates if the responsible is subject to FATCA regulations
• foreignAccountData (object, optional): Foreign account data of the responsible
• bankName (string, required): Name of the foreign bank
• accountNumber (string, required): Foreign account number
• country (string, required): Country of the foreign account
• corporateAccountId (long?, optional): Identifier of the corporate account associated with the responsible
Responses:
• 200 OK: Data of the company responsibles updated successfully.
Example:
\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"document\": \"123.456.789-00\",\n \"participation\": 50.0,\n \"canSign\": true,\n \"phone\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"number\": \"456\",\n \"complement\": \"Apt 789\",\n \"district\": \"Downtown\",\n \"city\": \"Example City\",\n \"state\": \"EX\",\n \"postalCode\": \"12345-678\"\n },\n \"isFATCA\": false,\n \"foreignAccountData\": {\n \"bankName\": \"Example Bank\",\n \"accountNumber\": \"123456789\",\n \"country\": \"USA\"\n },\n \"corporateAccountId\": 1\n }\n ],\n \"message\": \"Data of the company responsibles updated successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The id, name, document, participation, canSign, and isFATCA fields are required and must be provided in the request body.
Allows updating the documents of a corporate client (PJ) by uploading document files.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: multipart/form-data
• Authorization: Bearer {{token}}
[Request Body]
• Type: multipart/form-data
Example:
\nsocialContract.id: 366\nsocialContract.file: (binary)\ncompanyResponsibles[0].id: 490\ncompanyResponsibles[0].file: (binary)\n\nRequest Body Properties:
\nsocialContract (DocumentPartnerDto, required): The social contract document of the client.
• id (int, required): Unique identifier of the social contract document.
• file (IFormFile, required): The file content to be uploaded.
companyResponsibles (List, required): List of documents of the company responsibles
• id (int, required): Unique identifier of the responsible's document.
• file (IFormFile, required): The file content to be uploaded.
Responses:
• 200 OK: Documents updated successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"socialContract\": {\n \"fileName\": \"social_contract.pdf\",\n \"fileContent\": \"base64_encoded_content\"\n },\n \"companyResponsibles\": [\n {\n \"fileName\": \"responsible_document_1.pdf\",\n \"fileContent\": \"base64_encoded_content\"\n },\n {\n \"fileName\": \"responsible_document_2.pdf\",\n \"fileContent\": \"base64_encoded_content\"\n }\n ]\n },\n \"message\": \"Documents updated successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The fileName and fileContent fields are required for each document in the request body.
This section provides endpoints to manage Company clients (PF).
\n","_postman_id":"1b2cef54-f303-4387-b2e9-aab5db5efa7a"},{"name":"Client PF","item":[{"name":"Create User","id":"3ce4e801-a9af-4406-be9f-4c11c2ed222e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientType\": \"0\",\r\n \"additionalEmails\": [\r\n {\r\n \"email\": \"celio@gmail.com\"\r\n }\r\n ],\r\n \"document\": \"56368364734\",\r\n \"name\": \"CÉLIO JORGE\",\r\n \"phoneNumber\": \"11958785425\",\r\n \"email\": \"celio@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/{{API_VERSION}}/v1/partner/public/clients/create-pf","description":"Updates the basic data of an individual client (PF) by ID with the provided data.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Body]
• Type: application/json
Example:
\n{\n \"id\": 1, // Unique identifier of the individual account\n \"sex\": \"M\", // Sex of the account holder. M - Male, F - Female\n \"isPublicAgent\": true, // Indicates if the account holder is a public agent\n \"publicAgentDescription\": \"Public agent description\", // Additional information about the public agent\n \"anualIncome\": 50000.00, // Annual income of the individual account\n \"isResidentAbroad\": false, // Indicator of residence abroad\n \"postalCode\": \"12345-678\", // Postal code of the address\n \"address\": \"123 Main St\", // Address\n \"number\": \"456\", // Number associated with the address\n \"complement\": \"Apt 789\", // Address complement\n \"district\": \"Downtown\", // District of the address\n \"city\": \"Metropolis\", // City of the address\n \"state\": \"NY\", // State of the address\n \"countryId\": 1 // Country ID of the address\n}\n\nRequest Body Properties:
\n• id (long, required): Unique identifier of the individual account
• sex (string, required): Sex of the account holder. M - Male, F - Female
• isPublicAgent (bool, required): Indicates if the account holder is a public agent
• publicAgentDescription (string, optional): Additional information about the public agent
• anualIncome (decimal, required): Annual income of the individual account
• isResidentAbroad (bool, required): Indicator of residence abroad
• postalCode (string, required): Postal code of the address
• address (string, required): Address
• number (string, required): Number associated with the address
• complement (string, optional): Address complement
• district (string, required): District of the address
• city (string, required): City of the address
• state (string, required): State of the address
• countryId (long, required): Country ID of the address
Responses:
• 200 OK: Basic data of the individual client updated successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"sex\": \"M\",\n \"isPublicAgent\": true,\n \"publicAgentDescription\": \"Public agent description\",\n \"anualIncome\": 50000.00,\n \"isResidentAbroad\": false,\n \"postalCode\": \"12345-678\",\n \"address\": \"123 Main St\",\n \"number\": \"456\",\n \"complement\": \"Apt 789\",\n \"district\": \"Downtown\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"countryId\": 1\n },\n \"message\": \"Individual client basic data updated successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
Example:
{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The id, sex, isPublicAgent, anualIncome, isResidentAbroad, postalCode, address, number, district, city, state, and countryId fields are required and must be provided in the request body.
Registers a new individual client (PF) with the provided data.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Body]
• Type: application/json
Example:
\n{\n \"document\": \"123.456.789-01\", // Document Number (CPF)\n \"name\": \"John Doe\", // Contact Name\n \"phoneNumber\": \"123-456-7890\", // Contact Phone Number\n \"email\": \"john.doe@example.com\", // Contact Email Address\n \"additionalEmails\": [ // List of Additional Contact Emails\n {\n \"email\": \"additional1@example.com\"\n },\n {\n \"email\": \"additional2@example.com\"\n }\n ]\n}\n\nRequest Body Properties:
• document (string, required): Document Number (CPF)
• name (string, required): Contact Name
• phoneNumber (string, required): Contact Phone Number
• email (string, required): Contact Email Address
• additionalEmails (array of objects, optional): List of Additional Contact Emails
• email (string, required): Additional Contact Email
Responses:
• 200 OK: Individual client registered successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"document\": \"123.456.789-01\",\n \"name\": \"John Doe\",\n \"phoneNumber\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"additionalEmails\": [\n {\n \"email\": \"additional1@example.com\"\n },\n {\n \"email\": \"additional2@example.com\"\n }\n ]\n },\n \"message\": \"Individual client registered successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The document field must be a valid Brazilian CPF number.
• The name, phoneNumber, and email fields are required and must be provided in the request body.
Updates the complementary data of an individual client (PF) by ID with the provided data.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Body]
• Type: application/json
Example:
\n{\n \"id\": 1, // Unique identifier of the client\n \"isFATCA\": true, // Indicates if the client is subject to FATCA\n \"identificationNumber\": \"123456789\", // Client's identification number\n \"isPEP\": false // Indicates if the client is a politically exposed person (PEP)\n}\n\nRequest Body Properties:
\n• id (long, required): Unique identifier of the client
• isFATCA (bool, required): Indicates if the client is subject to FATCA
• identificationNumber (string, required): Client's identification number
• isPEP (bool, required): Indicates if the client is a politically exposed person (PEP)
Responses:
• 200 OK: Complementary data of the individual client updated successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"isFATCA\": true,\n \"identificationNumber\": \"123456789\",\n \"isPEP\": false\n },\n \"message\": \"Individual client complementary data updated successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The id, isFATCA, identificationNumber, and isPEP fields are required and must be provided in the request body.
Updates the documents of an individual client (PF) by uploading the provided files.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: multipart/form-data
• Authorization: Bearer {{token}}
[Request Body]
• Type: multipart/form-data
Example:
\npersonalFile.id: 55\npersonalFile.file: (binary)\n\nRequest FormProperties:
\nResponses:
• 200 OK: Documents of the individual client updated successfully.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"personalFile\": {\n \"id\": 1,\n \"fileName\": \"document.pdf\",\n \"fileType\": \"application/pdf\"\n }\n },\n \"message\": \"Individual client documents updated successfully.\"\n}\n\n• 400 Bad Request: Invalid data provided for client registration.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Invalid data provided.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\nNotes:
• The personalFile field is required and must be provided in the request body.
This section provides endpoints to manage Individual Clients (PF).
\n","_postman_id":"57b59e99-5bbf-4777-8cd1-ec39c0aa5370"},{"name":"Get Filtered","id":"4e6385e1-c519-492e-886e-9e31edbc7c46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/{{API_VERSION}}/v1/partner/public/clients/get-filtered?page=0&orderBy[column]=&rowsPerPage=10","description":"Retrieves a paginated list of clients based on filtering criteria.
\n[Authorization]
• Type: Bearer Token
[Headers]
• Content-Type: application/json
• Authorization: Bearer {{token}}
[Request Parameters]
• Type: query
Example:
\n{\n \"name\": \"John Doe\", // Name of the individual or corporate client\n \"document\": \"123456789\", // Document number (CPF/CNPJ)\n \"clientType\": 0, // Client type: 0 for PF (individual), 1 for PJ (corporate)\n \"status\": 8, // Registration status: 8 for APPROVED, 1 for PROCESSING\n \"page\": 1, // Page number for pagination\n \"size\": 10 // Number of items per page\n}\n\nRequest Parameters Properties:
• name (string, optional): Name of the individual or corporate client.
• document (string, optional): Document number (CPF/CNPJ).
• clientType (EPersonType, optional): Client type. Acceptable values: 0 for PF (individual), 1 for PJ (corporate).
• status (EStatusPersonalCheck, optional): Registration status. Acceptable values: 8 for APPROVED, 1 for PROCESSING.
• page (int, optional): Page number for pagination.
• size (int, optional): Number of items per page.
Responses:
• 200 OK: A paginated list of clients.
Example:
\n{\n \"success\": true,\n \"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"document\": \"123456789\",\n \"participation\": 50.0,\n \"canSign\": true,\n \"phone\": \"555-1234\",\n \"email\": \"john.doe@example.com\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"Anytown\",\n \"state\": \"CA\",\n \"zipCode\": \"12345\"\n },\n \"isFATCA\": false,\n \"foreignAccountData\": null,\n \"corporateAccountId\": 1001\n }\n ],\n \"totalItems\": 1,\n \"totalPages\": 1,\n \"currentPage\": 1\n },\n \"message\": \"Clients retrieved successfully.\"\n}\n\n• 401 Unauthorized: User is not authenticated.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Unauthorized\"\n}\n\n• 404 Not Found: No responsible found with the provided client ID.
\nExample:
\n{\n \"success\": false,\n \"message\": \"Client not found.\"\n}\n\nNotes:
• The name, document, clientType, and status fields are optional and can be used to filter the clients.