curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"fullName": "John Doe",
"birthdate": "1987-01-01",
"primaryCitizenship": "US",
"address": {
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
'{
"profile": {
"code": "profile",
"status": "ok",
"verification": {
"model": "none",
"method": "manual",
"dependencies": [],
"rules": {
"fullName": {
"presence": "required",
"editable": true
},
"birthdate": {
"presence": "required",
"editable": true
},
"birthplace": {
"presence": "disallowed",
"editable": false,
"rules": {
"country": {
"presence": "required",
"editable": false
},
"town": {
"presence": "required",
"editable": false
}
}
},
"primaryCitizenship": {
"presence": "disallowed",
"editable": false
},
"otherCitizenships": {
"presence": "disallowed",
"editable": false
},
"address": {
"presence": "required",
"editable": true,
"rules": {
"subdivision": {
"presence": "optional",
"editable": false
},
"city": {
"presence": "required",
"editable": true
},
"line1": {
"presence": "required",
"editable": true
},
"line2": {
"presence": "optional",
"editable": true
},
"postalCode": {
"presence": "required",
"editable": true
}
}
}
}
},
"input": {
"fullName": "John Doe",
"birthdate": "1987-01-01",
"primaryCitizenship": "US",
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
}KYC
Update profile
Update the profile process for an individual user.
PATCH
/
core
/
kyc
/
processes
/
profile
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"fullName": "John Doe",
"birthdate": "1987-01-01",
"primaryCitizenship": "US",
"address": {
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
'{
"profile": {
"code": "profile",
"status": "ok",
"verification": {
"model": "none",
"method": "manual",
"dependencies": [],
"rules": {
"fullName": {
"presence": "required",
"editable": true
},
"birthdate": {
"presence": "required",
"editable": true
},
"birthplace": {
"presence": "disallowed",
"editable": false,
"rules": {
"country": {
"presence": "required",
"editable": false
},
"town": {
"presence": "required",
"editable": false
}
}
},
"primaryCitizenship": {
"presence": "disallowed",
"editable": false
},
"otherCitizenships": {
"presence": "disallowed",
"editable": false
},
"address": {
"presence": "required",
"editable": true,
"rules": {
"subdivision": {
"presence": "optional",
"editable": false
},
"city": {
"presence": "required",
"editable": true
},
"line1": {
"presence": "required",
"editable": true
},
"line2": {
"presence": "optional",
"editable": true
},
"postalCode": {
"presence": "required",
"editable": true
}
}
}
}
},
"input": {
"fullName": "John Doe",
"birthdate": "1987-01-01",
"primaryCitizenship": "US",
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
}
Update profile is the endpoint through which the user can update their personal information, such as name, date of birth, citizenship, and residential address.
This process solely updates the user’s personal information and residential address. It does not perform identity or address verification. For identity verification, refer to the identity process. For address verification, refer to the proof-of-address process.
Region-specific rules
Some fields are only accepted based on the user’s region. When a field isn’t accepted, it’s ignored rather than rejected (see Warnings).subdivision: only accepted when the proof-of-address process ispartner-verifiedfor your organization and thecountryfield is not set toUS.birthplace: only accepted when theaddress.countryfield is set to a country that requires it for regulatory compliance.otherCitizenships: only accepted when theaddress.countryfield is set to a country that requires it for regulatory compliance.
Warnings
If you submit a field whosepresence is disallowed or whose editable is false, it’s silently ignored rather than rejected, and reported in a warnings object on the response:
{
"profile": {
// ... profile fields ...
},
"warnings": {
"input": [
{
"code": "verification_rule_violated",
"message": "Field 'input.otherCitizenships' was ignored as its presence is disallowed",
"details": {
"property": "input.otherCitizenships",
"rule": "presence"
}
}
]
}
}
Was this page helpful?