It's designed to provide a quick integration path for external systems which capture these details.
643 matches
34 actions
Credas
34 actions
- Add a liveness image (UAP) to the specified registration.POSTv1.0.0
- Add a selfie image to the registration.POSTv1.0.0
- Add an id document image to the specified registration.POSTv1.0.0
- Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.POSTv1.0.0
- Checks if submitted documents are sufficient to complete registration.GETv1.0.0
- Creates new data check against a specified registration.POSTv1.0.0
- Creates new property registry check against the registration.POSTv1.0.0
- Creates new registration record, adds an ID document and optional selfie image in one go.POSTv1.0.0
- Creates new registration.POSTv1.0.0
- Finds a registration by the Id.GETv1.0.0
- Finds a registration by the RegCode.GETv1.0.0
- Finds registrations by the ReferenceId.GETv1.0.0
- Get a list of supported id document for the specified registration id.GETv1.0.0
- Get all id document images associated with a registration.GETv1.0.0
- GetCompanyGETv1.0.0
- Gets all available RegTypes.GETv1.0.0
- Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.GETv1.0.0
- Gets registration settings or nothing if there are no settings associated with the registration.GETv1.0.0
- Resends any invitation for the specified registration.POSTv1.0.0
- Retrieve the liveness action image (UAP) associated with a registration.GETv1.0.0
- Retrieve the liveness performed image associated with a registration.GETv1.0.0
- Retrieve the selfie image associated with a registration.GETv1.0.0
- Retrieves property registry check associated with the registration.GETv1.0.0
- Retrieves secure link to registration details page searching by the Registration Id.POSTv1.0.0
- Retrieves secure link to web verification page searching by the Registration Id.POSTv1.0.0
- Retrieves secure links to registration details pages searching by the Reference Id.POSTv1.0.0
- Retrieves secure links to web verification pages searching by the Reference Id.POSTv1.0.0
- Returns a detailed report on the analysis that has taken place of a scanned documentGETv1.0.0
- Searches for a company based on its Company Number and returns its details.POSTv1.0.0
- Sets an override for a specific check on the registration.PUTv1.0.0
- Updates a registration's contact details.PUTv1.0.0
- Updates registration settings.PUTv1.0.0
- Updates the status of the registration to one specified in the request.PUTv1.0.0
- Verifies bank account details.POSTv1.0.0
Security/Credas
Creates new registration record, adds an ID document and optional selfie image in one go.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
{
"type": "object",
"properties": {
"apikey": {
"type": "string"
},
"document": {
"type": "string"
},
"documentParameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"documentType": {
"type": "integer",
"format": "int32",
"description": "Other = 0, Passport = 1, DrivingLicence = 2, Visa = 3, CscsCard = 4, HomeOfficeLetter = 5, BirthCertificate = 6, NationalIdCard = 7, ResidencePermit = 9, UtilityBill = 11",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
9,
10,
11
]
},
"forename": {
"type": "string"
},
"middleName": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"referenceId": {
"type": "string"
},
"regTypeId": {
"type": "string",
"format": "uuid"
},
"selfie": {
"type": "string"
},
"significantPersonId": {
"type": "string",
"format": "uuid"
},
"surname": {
"type": "string"
}
},
"required": [
"apikey",
"document",
"documentType",
"forename",
"regTypeId",
"surname"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
{
"type": "object",
"required": [
"documentStatus",
"documentType",
"facialMatch",
"id",
"regCode"
],
"properties": {
"documentStatus": {
"type": "integer",
"format": "int32",
"description": "Active = 1, Deleted = 2, UnderReview = 3",
"enum": [
1,
2,
3
]
},
"documentType": {
"type": "integer",
"format": "int32",
"description": "Unknown = 0, Passport = 1, DrivingLicense = 2, IdentificationCard = 3, TaxLetter = 4, NIC_Letter = 5, TV_Licence = 6, UtilityBill = 7, HighRiskWorkLicence = 8, TravelPermit = 9, BankLetter = 10, BenefitLetter = 11, BankStatement = 12, NINO_Letter = 13, CouncilTax = 14, ResidentPermit = 15, PhotoCard = 16, RepaymentLetter = 17, Invoice = 18, Visa = 19, AgeIdentificationCard = 20, MedicareCard = 21, MilitaryIdentificationCard = 22, UtilityLetter = 23, CouncilDocument = 24, JobLicence = 25, MembershipIDCard = 26, MilitaryIDCard = 27, ProofOfAgeCard = 28, TravelPermitNew = 29, WeaponsLicence = 30, AccountStatement = 41, TenancyAgreement = 42, BankDocument = 43, BankLetterNew = 44, BankStatementNew = 45, BenefitLetterNew = 46, CouncilDocumentNew = 48, CouncilLetter = 49, CouncilTaxNew = 50, DWPDocument = 51, HMRCDocument = 52, InformationSheet = 53, InsuranceDocument = 54, InsuranceLetter = 55, InvoiceNew = 56, NICLetter = 57, NINOLetter = 58, OfficialDocument = 59, OfficialLetter = 60, RepaymentLetterNew = 61, TaxLetterNew = 62, TaxStatement = 63, TelBill = 64, TelLetter = 65, TelecommunicationDocument = 66, TVLicence = 67, UniversityLetter = 68, UtilityBillNew = 69, UtilityDocument = 70, UtilityLetterNew = 71, WaterBill = 72, WaterDocument = 73, HighRiskWorkLicenceNew = 74, PhotoCardNew = 75, MedicareCardNew = 76, Certificate = 77",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
41,
42,
43,
44,
45,
46,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77
]
},
"facialMatch": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"regCode": {
"type": "string"
}
}
}