TRANXACT.AI Help

HRMS · Identity Verification

Identity Verifications

Checks of an employee’s identity and right to work with the government service of your country: E-Verify (United States, from the Form I-9), PAN, Aadhaar e-KYC, UAN and DigiLocker (India), Iqama, GOSI, Qiwa and Absher (Saudi Arabia). Without a live connection (Platform › Connections) checks run in the sandbox. Only references, statuses and last four digits are kept -- never an Aadhaar number.

Type REST15 operationsBase path /api/hrms/identity-verificationsPublished as /api/v1/identity-verifications

Download specification (OpenAPI 3.1) Screen: Identity Verifications

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold HRMS › Identity Verifications on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablehr.identity_verifications · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

15 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/identity-verificationsList identity verifications

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "verification_no": "VER-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "i9_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "country": "US",
      "kind": "text",
      "provider": "text",
      "mode": "text",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "case_number": "CAS-000001",
      "reference": "text",
      "subject_last4": "text",
      "status": "draft"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/identity-verifications?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/identity-verifications/{id}Read one verification

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verification_no": "VER-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "i9_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "kind": "text",
  "provider": "text",
  "mode": "text",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "case_number": "CAS-000001",
  "reference": "text",
  "subject_last4": "text",
  "status": "draft"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/identity-verifications/kindsKinds

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/identity-verifications/kinds" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/identity-verifications/startStart

Request body

The keys this action reads (* = required; "one of" lists the only values):

kind, employeeId, employee_id, pan, aadhaar, shareCode, consent*, uan, docType, iqama; kind one of everify|pan|aadhaar_ekyc|aadhaar_offline|uan|digilocker|iqama|gosi|qiwa|absher

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"value","employeeId":"value","employee_id":"value","pan":"value","aadhaar":"value","shareCode":"value"}'
POST/api/hrms/identity-verifications/{id}/photo-matchPhoto match

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

matches

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/photo-match" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"matches":"value"}'
POST/api/hrms/identity-verifications/{id}/notify-employeeNotify employee

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/notify-employee" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/identity-verifications/{id}/referRefer

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refer" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/identity-verifications/{id}/refreshRefresh

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refresh" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/identity-verifications/{id}/closeClose

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason; reason one of no_action_continues|no_action_terminated

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason;":"value"}'
GET/api/hrms/identity-verifications/{id}/eventsEvents

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/identity-verifications/{id}/noticeNotice

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/notice" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/identity-verificationsPost identity verifications

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/identity-verifications/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/identity-verifications/{id}Put identity verifications

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/identity-verifications/{id}Delete identity verifications

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/hrms/identity-verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a verification, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
verification_notextread onlyVerification no
employee_iduuidread onlyEmployee id
i9_record_iduuidread onlyI9 record id
countrytextread onlyCountry
kindtextread onlyKind
providertextread onlyProvider
modetextread onlyMode
connection_iduuidread onlyConnection id
case_numbertextread onlyCase number
referencetextread onlyReference
subject_last4textread onlySubject last4
statustextread onlyStatus
status_detailtextread onlyStatus detail
due_bydateread onlyDue by
tnc_notified_attimestamp with time zoneread onlyTnc notified at
further_action_notice_iduuidread onlyFurther action notice id
employee_decisiontextread onlyEmployee decision
employee_decided_attimestamp with time zoneread onlyEmployee decided at
referred_attimestamp with time zoneread onlyReferred at
referral_duedateread onlyReferral due
closure_reasontextread onlyClosure reason
closed_attimestamp with time zoneread onlyClosed at
late_reasontextread onlyLate reason
request_summaryjsonbread onlyRequest summary
resultjsonbread onlyResult
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Identity Verifications for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.