Skip to main content
POST
Submit Employee KYC

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Body

employee_id
string
required
Example:

"emp_456"

full_name
string
required
Maximum string length: 191
Example:

"Jane Doe"

id_type
string
required
Maximum string length: 64
Example:

"passport"

id_number
string
required
Maximum string length: 191
Example:

"X1234567"

dob
string<date>
required
Example:

"1990-04-12"

street
string
required
Maximum string length: 255
Example:

"100 Main St"

city
string
required
Maximum string length: 191
Example:

"Miami"

postal_code
string
required
Maximum string length: 32
Example:

"33101"

gov_id_type
string
required
Maximum string length: 64
Example:

"passport"

gov_id_number
string
required
Maximum string length: 191
Example:

"X1234567"

state_id
integer

Numeric id from List States. An unknown id returns 422.

country_id
string

ISO 3166-1 alpha-2.

Example:

"US"

nationality
string

ISO 3166-1 alpha-2.

Example:

"US"

occupation
string
Maximum string length: 191
gov_id_image
file
gov_id_image_url
string<uri>
Example:

"https://example.com/id.jpg"

payslip
file
payslip_url
string<uri>
proof_of_address
file
proof_of_address_url
string<uri>

Response

KYC submitted

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
Example:

"Request successful"

data
object