Skip to main content
POST
/
kyc-verifications
Create KYC Verification
curl --request POST \
  --url https://api.atlas.co/functions/v1/kyc-verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "external_customer_id": "<string>",
  "verification_level": "standard",
  "provider": "persona",
  "pii_tokens": {},
  "metadata": {}
}
'
{
  "id": "<string>",
  "status": "pending",
  "verification_level": "<string>",
  "provider": "<string>",
  "provider_session_token": "<string>",
  "risk_score": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "submitted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Body

application/json
customer_id
string
external_customer_id
string
verification_level
enum<string>
default:standard
Available options:
basic,
standard,
enhanced,
business
provider
enum<string>
default:persona
Available options:
persona,
alloy,
socure,
manual
pii_tokens
object
metadata
object

Response

Verification created

id
string
status
enum<string>
Available options:
pending,
submitted,
approved,
rejected
verification_level
string
provider
string
provider_session_token
string
risk_score
integer
created_at
string<date-time>
submitted_at
string<date-time>
completed_at
string<date-time>