### Customer Creation Response (JSON) Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts Example JSON response for a successfully created individual customer. It includes the customer's ID, status, and all provided details. ```json { "id": "0196c8cd-839a-7389-b5ce-0a0776023e55", "status": "approved", "type": "individual", "first_name": "Satoshi", "last_name": "Nakamoto", "email": "satoshi@email.com", "phone_number": "1234567890", "date_of_birth": "1990-01-01", "identity_documents": [ { "type": "national_id", "value": "12345678900", "country": "BRA" } ], "address": { "street_line_1": "123 Main St", "street_line_2": "Apt 4B", "city": "New York", "state": "NY", "postal_code": "10001", "country": "USA" } "created_at": "2025-05-13T08:40:33.946Z", "updated_at": "2025-05-13T12:26:53.405Z" } ``` ```json { "id": "0196c8cd-839a-7389-b5ce-0a0776023e55", "status": "approved", "type": "business", "business_legal_name": "Satoshi Company LLC", "email": "satoshi@email.com", "phone_number": "1234567890" "identity_documents": [ { "type": "tax_id", "value": "96585813000160", "country": "BRA" } ], "address": { "street_line_1": "123 Main St", "street_line_2": "Apt 4B", "city": "New York", "state": "NY", "postal_code": "10001", "country": "USA" } "created_at": "2025-05-13T08:40:33.946Z", "updated_at": "2025-05-13T12:26:53.405Z" } ``` -------------------------------- ### Create Individual Customer (curl) Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts Example of creating an individual customer profile using a curl request. This requires specifying 'individual' as the type and providing personal details along with identity documents and address. ```curl curl https://api.unblockpay.com/customers \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: YOUR_SECRET_TOKEN' \ --data '{ "type": "individual", "first_name": "Satoshi", "last_name": "Nakamoto", "email": "satoshi@email.com", "phone_number": "1234567890", "date_of_birth": "1990-01-01", "identity_documents": [ { "type": "national_id", "value": "12345678900", "country": "BRA" } ], "address": { "street_line_1": "123 Main St", "street_line_2": "Apt 4B", "city": "New York", "state": "NY", "postal_code": "10001", "country": "USA" } }' ``` -------------------------------- ### Get Customer Details Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts Retrieves specific details for a single customer using their unique identifier. ```APIDOC ## GET /customers/{id} ### Description Retrieves specific details for a single customer using their unique identifier. ### Method GET ### Endpoint /customers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the customer. ### Response #### Success Response (200 OK) - **id** (string) - The unique identifier for the customer. - **type** (string) - The type of customer. - **email** (string) - The email address of the customer. - **phone_number** (string) - The phone number of the customer. - **first_name** (string) - The first name of the customer. - **last_name** (string) - The last name of the customer. - **company_name** (string) - The name of the business. - **tax_id** (string) - The tax ID of the business. - **status** (string) - The verification status of the customer. - **created_at** (string) - The timestamp when the customer was created. - **updated_at** (string) - The timestamp when the customer was last updated. #### Response Example ```json { "id": "cus_12345abcde", "type": "individual", "email": "john.doe@example.com", "phone_number": "+1234567890", "first_name": "John", "last_name": "Doe", "company_name": null, "tax_id": null, "status": "verified", "created_at": "2023-10-27T10:00:00Z", "updated_at": "2023-10-27T10:30:00Z" } ``` ``` -------------------------------- ### Create Business Customer (curl) Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts Example of creating a business customer profile using a curl request. This requires specifying 'business' as the type and providing business details along with identity documents and address. ```curl curl https://api.unblockpay.com/customers \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: YOUR_SECRET_TOKEN' \ --data '{ "type": "business", "business_legal_name": "Satoshi Company LLC", "email": "satoshi@email.com", "phone_number": "1234567890", "identity_documents": [ { "type": "tax_id", "value": "96585813000160", "country": "BRA" } ], "address": { "street_line_1": "123 Main St", "street_line_2": "Apt 4B", "city": "São Paulo", "state": "SP", "postal_code": "04514-100", "country": "BRA" } }' ``` -------------------------------- ### Create Customer Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts Creates a new customer account. All users must be registered as customers through UnblockPay's Customers API and go through a KYC or KYB process to verify their identity. ```APIDOC ## POST /customers ### Description Creates a new customer account. All users must be registered as customers through UnblockPay's Customers API and go through a KYC or KYB process to verify their identity. ### Method POST ### Endpoint /customers ### Parameters #### Request Body - **type** (string) - Required - The type of customer, either 'individual' or 'business'. - **email** (string) - Required - The email address of the customer. - **phone_number** (string) - Optional - The phone number of the customer. - **first_name** (string) - Required if type is 'individual' - The first name of the customer. - **last_name** (string) - Required if type is 'individual' - The last name of the customer. - **company_name** (string) - Required if type is 'business' - The name of the business. - **tax_id** (string) - Optional - The tax ID of the business. ### Request Example ```json { "type": "individual", "email": "john.doe@example.com", "phone_number": "+1234567890", "first_name": "John", "last_name": "Doe" } ``` ### Response #### Success Response (201 Created) - **id** (string) - The unique identifier for the created customer. - **type** (string) - The type of customer. - **email** (string) - The email address of the customer. - **phone_number** (string) - The phone number of the customer. - **first_name** (string) - The first name of the customer. - **last_name** (string) - The last name of the customer. - **company_name** (string) - The name of the business. - **tax_id** (string) - The tax ID of the business. - **status** (string) - The verification status of the customer (e.g., 'pending', 'verified', 'rejected'). #### Response Example ```json { "id": "cus_12345abcde", "type": "individual", "email": "john.doe@example.com", "phone_number": "+1234567890", "first_name": "John", "last_name": "Doe", "company_name": null, "tax_id": null, "status": "pending" } ``` ``` -------------------------------- ### List Customers Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts Retrieves a list of all customers. This endpoint can be used to view all registered users and their basic information. ```APIDOC ## GET /customers ### Description Retrieves a list of all customers. This endpoint can be used to view all registered users and their basic information. ### Method GET ### Endpoint /customers ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of customers to return. - **offset** (integer) - Optional - The number of customers to skip before returning results. ### Response #### Success Response (200 OK) - **customers** (array) - A list of customer objects. - **id** (string) - The unique identifier for the customer. - **type** (string) - The type of customer. - **email** (string) - The email address of the customer. - **status** (string) - The verification status of the customer. #### Response Example ```json { "customers": [ { "id": "cus_12345abcde", "type": "individual", "email": "john.doe@example.com", "status": "verified" }, { "id": "cus_67890fghij", "type": "business", "email": "acme.corp@example.com", "status": "pending" } ] } ``` ``` -------------------------------- ### POST /customer - Create Customer Source: https://docs.unblockpay.com/api-reference#description/introduction/guide/concepts This endpoint allows you to create customer profiles, which are essential for processing transactions. You can create profiles for either individuals or businesses. ```APIDOC ## POST /customer ### Description Creates customer profiles representing your business users. This is a mandatory step before processing any pay-ins or payouts. ### Method POST ### Endpoint `/customer` ### Parameters #### Request Body - **type** (string) - Required - Specifies the customer type. Accepts either `"individual"` or `"business"`. - **first_name** (string) - Required (for individuals) - The first name of the individual. - **last_name** (string) - Required (for individuals) - The last name of the individual. - **business_legal_name** (string) - Required (for businesses) - The legal name of the business. - **email** (string) - Required - The email address of the customer. - **phone_number** (string) - Required - The phone number of the customer. - **date_of_birth** (string) - Optional (for individuals) - The date of birth of the individual in `YYYY-MM-DD` format. - **identity_documents** (array) - Required - A list of identity documents for verification. - **type** (string) - Required - The type of identity document. For individuals: `"passport"`, `"national_id"`, `"driver_license"`. For businesses: `"tax_id"`. - **value** (string) - Required - The document number. - **country** (string) - Required - The ISO 3166-1 alpha-3 country code where the document was issued. - **address** (object) - Required - The address of the customer. - **street_line_1** (string) - Required - The primary street address. - **street_line_2** (string) - Optional - Additional address details (e.g., apartment number). - **city** (string) - Required - The city. - **state** (string) - Required - The state or province. - **postal_code** (string) - Required - The postal code. - **country** (string) - Required - The ISO 3166-1 alpha-3 country code of the address. ### Request Example ```json { "type": "individual", "first_name": "Satoshi", "last_name": "Nakamoto", "email": "satoshi@email.com", "phone_number": "1234567890", "date_of_birth": "1990-01-01", "identity_documents": [ { "type": "national_id", "value": "12345678900", "country": "BRA" } ], "address": { "street_line_1": "123 Main St", "street_line_2": "Apt 4B", "city": "New York", "state": "NY", "postal_code": "10001", "country": "USA" } } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the created customer. - **status** (string) - The current status of the customer profile (e.g., `"approved"`). - **type** (string) - The type of customer created (`"individual"` or `"business"`). - **first_name** (string) - The first name (if type is individual). - **last_name** (string) - The last name (if type is individual). - **business_legal_name** (string) - The legal name of the business (if type is business). - **email** (string) - The customer's email address. - **phone_number** (string) - The customer's phone number. - **date_of_birth** (string) - The date of birth (if type is individual). - **identity_documents** (array) - Details of the provided identity documents. - **address** (object) - The customer's address details. - **created_at** (string) - Timestamp when the customer was created. - **updated_at** (string) - Timestamp when the customer was last updated. #### Response Example ```json { "id": "0196c8cd-839a-7389-b5ce-0a0776023e55", "status": "approved", "type": "individual", "first_name": "Satoshi", "last_name": "Nakamoto", "email": "satoshi@email.com", "phone_number": "1234567890", "date_of_birth": "1990-01-01", "identity_documents": [ { "type": "national_id", "value": "12345678900", "country": "BRA" } ], "address": { "street_line_1": "123 Main St", "street_line_2": "Apt 4B", "city": "New York", "state": "NY", "postal_code": "10001", "country": "USA" }, "created_at": "2025-05-13T08:40:33.946Z", "updated_at": "2025-05-13T12:26:53.405Z" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.