API Update: Enhanced User Information & Streamlined KYC

To improve data completeness and streamline our identity verification processes, we are introducing several updates to our user creation and Standard KYC APIs.

These changes make phone and address information mandatory by default for new customer integrations and simplify the payload for KYC submissions. For our existing customers, these changes are non-breaking.

1. User Creation API Changes

The following changes apply to both the Create Individual User and Create Business User endpoints.

Affected Endpoints:

• POST /v2/users/individual
• POST /v2/users/business

Mandatory Phone and Address (New Integrations)

For all new customers, the phone and address fields are now mandatory when creating a user. This is enforced by a default configuration setting.

• For existing customers, this is a non-breaking change. Your current integration will continue to work without modification. If you wish to enforce these new requirements, please contact our support team to update your configuration.

New phoneCode Field

We have added a new optional phoneCode field at the root level of the user creation payload. This allows you to provide the country dialing code for the phone number, ensuring better accuracy.

Updated create-individual-user Example

This example shows the newly required address object and the new phoneCode field.

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": "IN",
    "phoneCode": "+91",
    "phone": "9876543210",
    "address": {
        "street": "123 Tech Park",
        "city": "Bengaluru",
        "state": "Karnataka",
        "postalCode": "560001",
        "country": "IN"
    }
}'

2. Standard KYC API Simplification

To streamline the Standard KYC process, we have removed redundant fields from the submission payload.

Affected Endpoint:

• POST /v2/kyc/standard

Change Description:

The firstName, lastName, and country fields are no longer required in the Standard KYC submission payload. The API will now use the user data already stored in our system from the user creation step, reducing the amount of information you need to send.

Example Payload Comparison:

Before (Old Payload):

{
  "country": "AU",
  "email": "[email protected]",
  "firstName": "Alex",
  "lastName": "Muel",
  "redirectUrl": "https://www.example.com"
}

After (New, Simplified Payload):

{
  "email": "[email protected]",
  "redirectUrl": "https://www.example.com"
}

Summary of Changes & Reasons

• Mandatory User Info: Requiring phone and address by default helps ensure user profiles are more complete, which aids in compliance and customer support.
• NewphoneCode Field: Provides a standardized way to capture country codes for phone numbers.
• Streamlined KYC: Removing redundant fields from the Standard KYC API call simplifies the integration and reduces the chance of data mismatch errors.

Action Required

• For New Customers: You must include the phone and address objects in all calls to the user creation endpoints. We also highly recommend including the new phoneCode field.
• For Existing Customers: No immediate action is required. Your current integration will continue to function. You may optionally update your code to include the new fields. To make phone and address mandatory for your account, please contact support.

Support

If you have any questions about these changes or how to best adapt your integration, please contact our technical support team.