/get_verifications/<verification_uuid>
Advanced KYC endpoint that returns a single, specified verification record.
Run this endpoint after /register and /kyc. For a full list of verification records for an entity, call /get_verifications.
Advanced KYC ONLY
Only use this endpoint if you are utilizing the new Advanced KYC.
Timing and Webhooks
Please make use of our webhooks so that you are notified when changes have been made. On average it takes about 33 seconds for an ID verification to complete, but can take less or more time.
If a verification status stays in
review
ordocuments_required
for 30 days, the evaluation will expire and the status will befailed
.
Request
Authorization / Authentication
Apps using Access Token Authorization
Use a valid access token in an Authorization: Bearer request header.
See Auth Token Overview for more details.
NOTE: Though we recommend using JWT, you can use this endpoint with ECDSA.
POST /0.2/get_verifications/<verification_uuid> HTTP/1.1
sandbox.silamoney.com
Content-Type: application/json
Authorization: Bearer [GENERATED JWT TOKEN HERE]
{
"header": {
"created": 1234567890, //required
"app_handle": "your_app_handle", //required
"user_handle":"user_handle", //required
"version": "0.2",
"reference": "<your unique id>"
}
}
***
HTTP/1.1 200 OK
{
'success': true,
'status': 'SUCCESS',
'message': 'User has passed ID verification!',
'response_time_ms': '171',
'reference': <provided reference_id>,
'verification_id': <provided verification uuid>,
'entity_type': 'individual' or 'business',
'verification_status': 'passed',
'flow': <uuid of KYC Flow>,
'checks_performed': [KYC options selected],
'requested_at': 1592339985,
'updated_at': 1592340016,
'parent_verification': <verification_uuid of parent verification if member of KYB else null>,
'reasons': {
<entity_handle>: [<List of reasons providing rationale for the outcome, this will vary but should not be empty>]
},
'kyc_action': "entity_data" or "doc_upload" or "review",
'certification_status': null or bool
}
Request Attributes
Key | Type | Description |
---|---|---|
header | JSON object | Required. Required keys: created - Unix epoch timestamp in seconds. Must not be future-dated and must not be dated more than 5 minutes in the past.app_handle - your app handleuser_handle - the user_handle to pull verification data for.Optional keys: reference : Can be any value for your own reference. If not provided, one will be assigned.version : Cannot be null if key is present. Valid values: 0.2, v0.2, V0.2 |
verification_uuid | string | Required. The UUID of the verification record you want to see. Can be found in responses from either /kyc or /get_verifications. |
Verification Statuses
Verification Status | Description |
---|---|
'unverified' | Entity has not had a KYC evaluation |
'passed' | Entity has passed KYC |
'pending' | An entity's KYC evaluation is in progress |
'review' | Under manual review by Sila |
'failed' | Entity has failed KYC |
'member_failed' | Business member failed KYC. KYB will need to be re-requested to begin a new verification attempt (2 attempts max) |
'member_review' | Happens when a business member is under manual review. Documents may or may not be required for verification |
'member_pending' | A business member's KYC evaluation is in progress |
'documents_required' | Review entity PII (/get_entity); upload document if reviewing PII doesn't pass entity |
'documents_received' | Documents were received but not reviewed |
'webhook_pending' | Waiting for a webhook response from a KYC provider |
If your end user receives documents_required
documents_required
You have 5 total opportunities to pass. The first is giving the end user a chance to update their PII, then you have four chances to upload documentation:
- The first try will always be to update end user PII. Use /update. Once updated, use /resume_verification to restart the verification process.
- If the end user still doesn't pass, the next try will be to upload a doc. Once uploaded, use /resume_verification to restart the verification process.
- You are given three more tries to upload that same doc - you cannot upload a different doc, so be sure the one that is uploaded is the correct one. Continue to use /resume_verification to restart the verification process.
Which action you will need to take next will be indicated in the action_needed
field of this call's response or the kyc_action
webhook.
entity_data
- End user PII should be revieweddoc_upload
- Use /documents to upload verification documentationreview
- Indicates no customer action as the verification is under manual review by Sila
Reason Tags
Tags returned by Alloy explaining the verification result. Please be aware tags are specific to KYC or KYB, not both.
KYC or KYB | Tag |
---|---|
KYC | SSN Miskey |
KYC | SSN Warning |
KYC | SSN Velocity |
KYC | SSN Not Verified |
KYC | KYC SSN Match |
KYC | KYC Name Match |
KYC | KYC DOB Match |
KYC | KYC Address Match |
KYC | KYC Review |
KYC | DOB Miskey |
KYC | DOB Not Verified |
KYC | Fraud Review |
KYC | Denied Fraud |
KYC | Phone Warning |
KYC | Fraud Warning |
KYC | Fraud Risk |
KYC | Email Warning |
KYC | Email Velocity |
KYC | Address Warning |
KYC | Address Not Verified |
KYC | Velocity Warning |
KYC | Watchlist Review |
KYC | OFAC Match |
KYC | Name Not Verified |
KYB | Address Not Matched |
KYB | Address Matched |
KYB | FEIN Unmatched |
KYB | FEIN Found |
KYB | Company Name Verified |
KYB | Company Name Not Matched |
KYB | Middesk Pending |
KYB | Watchlist Warning |
KYB | Secretary of State Warning |
KYB | Secretary of State Match |
Responses
Status Code | Success Attribute | Description |
---|---|---|
200 | true | |
404 | false | Requested verification_uuid not found. "No KYC verification record can be found matching id {_uuid}" |
Updated about 2 months ago