API Update: `date` Field is Now Optional for Non-Ramp User Creation
To streamline user onboarding and provide greater flexibility for our partners, we are making the date
field optional for specific user creation flows. This change applies when creating users for non-ramp services, such as direct payouts or collections.
This is a non-breaking change and is effective immediately. It is designed to simplify integrations that do not require full KYC for their primary workflow.
Affected API Endpoints
The date
parameter is now optional for the following endpoints:
1. Create Individual User
Endpoint: POST https://sandbox-api.transfi.com/v2/users/individual
Change: The date
field (representing the user's date of birth) is no longer mandatory when creating an individual user for non-ramp flows.
Example Request (withoutdate
):
curl --location '[https://sandbox-api.transfi.com/v2/users/individual](https://sandbox-api.transfi.com/v2/users/individual)' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Basic [your_auth_token]' \
--data-raw '{
"firstName": "Jane",
"lastName": "Doe",
"email": "[email protected]",
"country": "PH",
"phone": "9876543210"
}'
2. Create Business User
Endpoint: POST https://sandbox-api.transfi.com/v2/users/business
Change: The date
field (representing the business's date of incorporation) is no longer mandatory when creating a business user for non-ramp flows.
Example Request (withoutdate
):
curl --location '[https://sandbox-api.transfi.com/v2/users/business](https://sandbox-api.transfi.com/v2/users/business)' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Basic [your_auth_token]' \
--data-raw '{
"businessName": "Doe Inc.",
"email": "[email protected]",
"country": "IN",
"phone": "1234567890"
}'
Reasons for Implementation
- Streamlined Onboarding: Reduces the number of required fields for creating a user, enabling faster and simpler integration for partners focused on non-ramp products.
- Increased Flexibility: Allows partners to tailor their user information collection process based on their specific product needs.
- Reduced User Friction: Simplifies the sign-up process where a date of birth or incorporation is not immediately necessary.
Changes Introduced
- Optional
date
Field: Thedate
parameter in both the Create Individual User and Create Business User APIs is no longer required.
What Remains Unchanged
- Mandatory for Ramp Flows: The
date
field remains strictly mandatory for any on-ramp or off-ramp service that requires KYC (Know Your Customer) or KYB (Know Your Business) verification. Attempting a ramp transaction for a user created without a date will result in a request for the missing information. - All Other Parameters: All other fields in the user creation API payloads remain unchanged.
- Existing Integrations: Existing integrations that currently send the
date
field will continue to work without any issues.
Action Required
- No Action Needed: Since this is a non-breaking change, no immediate action is required. Your existing integration will continue to function correctly.
- Optional Update: You may choose to update your integration to omit the
date
field for user creation in non-ramp flows to simplify your onboarding process.
Important Context
This update is intended to differentiate between user creation for simple payout/collection services and regulated on-ramp/off-ramp services. While the user can be created without a date, this information will be required later if that same user attempts to use a service that mandates identity verification.
Support
Should you have any questions regarding this update or how it impacts your specific workflow, please reach out to our technical support team for assistance.