Create a new identity verification document. Optionally attach files which will receive presigned upload URLs.
curl --request POST \
--url https://api.beltic.com/v1/identity/documents/idvs \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"attributes": {
"files": [
{
"filename": "<string>"
}
]
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"session": {
"data": {
"type": "session",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}
'{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "document/idv",
"attributes": {
"status": "pending",
"document_type": "<string>",
"name": {
"first": "<string>",
"middle": "<string>",
"last": "<string>"
},
"sex": "<string>",
"birth_date": "<string>",
"birth_place": "<string>",
"document_number": "<string>",
"issue_date": "<string>",
"expiry_date": "<string>",
"issuing_authority": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"subdivision": "<string>",
"postal_code": "<string>",
"country_code": "<string>"
},
"nationality": "<string>",
"personal_number": "<string>",
"document_class": "<string>",
"issuing_country": "<string>",
"place_of_issue": "<string>",
"files": [
{
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
],
"front_side": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"back_side": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"portrait": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"signature": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"created_at": "<string>",
"submitted_at": "<string>",
"processed_at": "<string>"
},
"relationships": {
"account": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"session": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"verification": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
},
"meta": {
"presigned_upload_urls": [
{
"file_id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://s3.amazonaws.com/beltic-documents/...",
"expires_in": 3600
}
]
}
}API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.beltic.com/v1/identity/documents/idvs \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"attributes": {
"files": [
{
"filename": "<string>"
}
]
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"session": {
"data": {
"type": "session",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}
'{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "document/idv",
"attributes": {
"status": "pending",
"document_type": "<string>",
"name": {
"first": "<string>",
"middle": "<string>",
"last": "<string>"
},
"sex": "<string>",
"birth_date": "<string>",
"birth_place": "<string>",
"document_number": "<string>",
"issue_date": "<string>",
"expiry_date": "<string>",
"issuing_authority": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"subdivision": "<string>",
"postal_code": "<string>",
"country_code": "<string>"
},
"nationality": "<string>",
"personal_number": "<string>",
"document_class": "<string>",
"issuing_country": "<string>",
"place_of_issue": "<string>",
"files": [
{
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
],
"front_side": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"back_side": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"portrait": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"signature": {
"id": "<string>",
"filename": "<string>",
"status": "pending_upload",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"created_at": "<string>",
"submitted_at": "<string>",
"processed_at": "<string>"
},
"relationships": {
"account": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"session": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"verification": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
},
"meta": {
"presigned_upload_urls": [
{
"file_id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://s3.amazonaws.com/beltic-documents/...",
"expires_in": 3600
}
]
}
}