🚀 VaultsPay API v1 is live. See what's new →
UsersCreate Personal Info

Create Personal Info

POST{baseUrl}/us/api/v1/kyc/personal

Payload

AttributeTypeRequiredDescription
userIdIntegerYesID of the user for whom the basic profile is being created.
firstNameStringYesUser’s first name.
lastNameStringYesUser’s last name.
nickNameStringNoPreferred name or alias.
dobString (YYYY-MM-DD)YesDate of birth.
genderEnum (MALE, FEMALE, OTHER)YesUser’s gender.
maritalStatusEnum (SINGLE, MARRIED)NoMarital status.
nationalityISO Alpha-3YesNationality (e.g., PAK).
countryOfBirthISO Alpha-3NoCountry of birth (e.g., USA).
countryOfResidenceISO Alpha-3NoCurrent country of residence (e.g., UKR).
tinStringNoTax Identification Number.
languageString/EnumNoPreferred language (e.g., ENGLISH).
Request Example
{
  "userId": 604,
  "firstName": "sardar",
  "lastName": "adil",
  "nickName": "sardarAdil",
  "dob": "1990-05-15",
  "gender": "MALE",
  "maritalStatus": "SINGLE",
  "nationality": "PAK",
  "countryOfBirth": "USA",
  "countryOfResidence": "UKR",
  "tin": "0112133232",
  "language": "ENGLISH"
}

Response

FieldTypeDescription
userIdIntegerUser ID.
firstNameStringStored first name.
lastNameStringStored last name.
nickNameStringStored nickname (if provided).
dobString (ISO 8601)Date of birth with time & timezone.
genderEnumMALE | FEMALE | OTHER.
maritalStatusEnumSINGLE | MARRIED | DIVORCED | …
nationalityISO Alpha-3Nationality code.
countryOfBirthISO Alpha-3Birth country code.
countryOfResidenceISO Alpha-3Residence country code.
languageStringPreferred language.
tinStringTax ID.
statusEnumPENDING | VERIFIED | REJECTED | …
200 — SUCCESS
{
  "userId": 604,
  "firstName": "sardar",
  "lastName": "adil",
  "nickName": "sardarAdil",
  "dob": "1990-05-15T00:00:00.000+00:00",
  "gender": "MALE",
  "maritalStatus": "SINGLE",
  "nationality": "PAK",
  "countryOfBirth": "USA",
  "countryOfResidence": "UKR",
  "language": "ENGLISH",
  "tin": "0112133232",
  "status": "PENDING"
}

Error Responses

HTTPCodeTypeMeaning / Notes
4001000INVALID_PAYLOADMissing/invalid fields.
4011001UNAUTHORISEDNot permitted.
4011003TOKEN_EXPIREDaccessToken expired; refresh token.
4011004SESSION_EXPIREDSession expired; login again.