Available APIs
| Description | Syntax |
|---|---|
| Creates and starts the execution of a transaction. | PUT https://gs.onespan.cloud/rpoc-saa/api/transaction/ |
| Get transaction status and metadata Retrieves the transaction status and metadata. | GET https://gs.onespan.cloud/rpoc-saa/api/transaction/TRANSACTION_ID |
| Retrieves the transaction verification results. | GET https://gs.onespan.cloud/rpoc-saa/api/transaction/TRANSACTION_ID/verification |
| Apply lender signature Applies the lender signature for a transaction. | PUT https://gs.onespan.cloud/rpoc-saa/api/transaction/TRANSACTION_ID/event |
| Retrieves the complete evidence audit trail for a transaction. | GET https://gs.onespan.cloud/rpoc-saa/api/transaction/TRANSACTION_ID/document/AuditTrailDocument/pdf |
| Retrieves metadata and content of the document which is being processed in the transaction. | GET https://gs.onespan.cloud/rpoc-saa/api/transaction/TRANSACTION_ID/document/DOCUMENT_ID/pdf |
| Cancels an ongoing transaction. | PUT https://gs.onespan.cloud/rpoc-saa/api/transaction/TRANSACTION_ID/event |
| Marks one or more complete or incomplete transactions for deletion. | POST https://gs.onespan.cloud/rpoc-saa/api/transaction/mark-for-erasure |
| Unmark transaction for erasure Reverts the marking of a transaction for erasure. | POST https://gs.onespan.cloud/rpoc-saa/api/transaction/unmark-for-erasure |
Workflow details
The following workflows are available:
Workflow ID: 00000001-0001-0001-0002-310000000007
North American Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVNA001-M (see IDV API RPOC workflow details (1))
Workflow ID: 00000001-0001-0002-0002-310000000007
North American Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVNA001-V (see IDV API RPOC workflow details (1))
Workflow ID: 00000001-0001-0001-0002-320000000007
North American Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVNA002-M (see IDV API RPOC workflow details (2))
Workflow ID: 00000001-0001-0002-0002-320000000007
North American Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVNA002-V (see IDV API RPOC workflow details (2))
Workflow ID: 00000001-0001-0001-0002-410000000007
Global Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVGL001-M (see IDV API RPOC workflow details (3))
Workflow ID: 00000001-0001-0002-0002-410000000007
Global Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVGL001-V (see IDV API RPOC workflow details (3))
Workflow ID: 00000001-0001-0002-0002-420000000007
Global Identity Verification (User Testing Rule Set), with multi-device handoff features, IDVGL002-V (see IDV API RPOC workflow details (4))
Workflow ID: 00000001-0000-0002-0002-420000000007
Global Document Verification (User Testing Rule Set), with multi-device handoff features, IDVGL002-V (see IDV API RPOC workflow details (4))
Workflow ID: 00000001-0001-0001-0001-200000000007
Recommended. North American Drivers License (Global Passport) Verification (Demo Friendly Rule Set), with multi-device handoff features (see IDV API RPOC workflow details (5))
Workflow ID: 00000000-0001-0001-0001-200000000007
North American Drivers License (Global Passport) Verification (Demo Friendly Rule Set) – Mobile Only (see IDV API RPOC workflow details (5))
Workflow ID: 00000001-0001-0002-0001-200000000007
Recommended. Europe, Central and South American Drivers License and ID Cards (Global Passport) Verification (Demo Friendly Rule Set), with multi-device handoff features (see IDV API RPOC workflow details (6))
Workflow ID: 00000000-0001-0002-0001-200000000007
Europe, Central and South American Drivers License and ID Cards (Global Passport) Verification (Demo Friendly Rule Set) – Mobile Only (see IDV API RPOC workflow details (6))
Workflow ID: 00000001-0001-0002-0002-200000000007
Recommended. Europe, Central and South American Drivers License and ID Cards (Global Passport) Verification (User Testing Rule Set), with multi-device handoff features (see IDV API RPOC workflow details (7))
Workflow ID: 00000000-0001-0002-0002-200000000007
Europe, Central and South American Drivers License and ID Cards (Global Passport) Verification (User Testing Rule Set) – Mobile Only (see IDV API RPOC workflow details (7))
The following tables list the possible verifications with details for each workflow:
true/false determines if the specific verification is enabled.
execute_only, affects_verification_status determines what happens if the specific verification is enabled.
X% specifies the threshold the specific verification must meet to be considered valid.
| 00000001-0001-0001-0002-310000000007 | 00000001-0001-0002-0002-310000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Multi device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/✓ |
| Matcher level | UAT | UAT |
| Country ID list | ||
| Name verification | true, affects_verification_status | true, affects_verification_status |
| Document number | true, execute_only | true, execute_only |
| Date of birth | true, affects_verification_status | true, affects_verification_status |
| Date of expiry | true, affects_verification_status | true, affects_verification_status |
| Document supported | ||
| Address match | ||
| Document authenticated | true, affects_verification_status | true, affects_verification_status |
| Face similarity | true, affects_verification_status | |
| Person alive | true, affects_verification_status | |
| Selfie authenticity | true, affects_verification_status | |
| Threshold: Similarity | 70% | 70% |
| Threshold: Selfie authenticity | 80% | |
| Threshold: Document authenticity | 65% | |
| Threshold: Liveness check | 70% | 90% |
| Threshold: Name match | 70% | |
| 00000001-0001-0001-0002-320000000007 | 00000001-0001-0002-0002-320000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Multi device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/✓ |
| Matcher level | UAT | UAT |
| Country ID list | ||
| Name verification | false, affects_verification_status | false, affects_verification_status |
| Document number | false, execute_only | false, execute_only |
| Date of birth | false, affects_verification_status | false, affects_verification_status |
| Date of expiry | true, affects_verification_status | true, affects_verification_status |
| Document supported | ||
| Address match | ||
| Document authenticated | true, affects_verification_status | true, affects_verification_status |
| Face similarity | true, affects_verification_status | |
| Person alive | true, affects_verification_status | |
| Selfie authenticity | true, affects_verification_status | |
| Threshold: Similarity | 70% | 70% |
| Threshold: Selfie authenticity | 80% | |
| Threshold: Document authenticity | 65% | |
| Threshold: Liveness check | 70% | 90% |
| Threshold: Name match | 70% | |
| 00000001-0001-0001-0002-410000000007 | 00000001-0001-0002-0002-410000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Multi device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/✓ |
| Matcher level | UAT | UAT |
| Country ID list | ||
| Name verification | true, affects_verification_status | true, affects_verification_status |
| Document number | false, execute_only | false, execute_only |
| Date of birth | true, affects_verification_status | true, affects_verification_status |
| Date of expiry | true, affects_verification_status | true, affects_verification_status |
| Document supported | ||
| Address match | ||
| Document authenticated | true, affects_verification_status | true, affects_verification_status |
| Face similarity | true, affects_verification_status | |
| Person alive | true, affects_verification_status | |
| Selfie authenticity | true, affects_verification_status | |
| Threshold: Similarity | 70% | 70% |
| Threshold: Selfie authenticity | 80% | |
| Threshold: Document authenticity | 65% | |
| Threshold: Liveness check | 70% | 90% |
| Threshold: Name match | 70% | |
| 00000001-0001-0002-0002-420000000007 | 00000001-0000-0002-0002-420000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Multi device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/– |
| Matcher level | UAT | UAT |
| Country ID list | ||
| Name verification | true, affects_verification_status | true, affects_verification_status |
| Document number | false, execute_only | false, execute_only |
| Date of birth | true, affects_verification_status | true, affects_verification_status |
| Date of expiry | true, affects_verification_status | true, affects_verification_status |
| Document supported | ||
| Address match | ||
| Document authenticated | true, affects_verification_status | true, affects_verification_status |
| Face similarity | true, affects_verification_status | |
| Person alive | true, affects_verification_status | |
| Selfie authenticity | true, affects_verification_status | |
| Threshold: Similarity | 70% | 70% |
| Threshold: Selfie authenticity | 80% | 80% |
| Threshold: Document authenticity | 65% | 65% |
| Threshold: Liveness check | 90% | 90% |
| Threshold: Name match | ||
| 00000001-0001-0001-0001-200000000007 | 00000000-0001-0001-0001-200000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Single device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/✓ |
| Matcher level | Developer | Developer |
| Country ID list | ||
| Name verification | false, execute_only | false, execute_only |
| Document number | false, execute_only | false, execute_only |
| Date of birth | false, execute_only | false, execute_only |
| Date of expiry | true, execute_only | true, execute_only |
| Document supported | true, execute_only | true, execute_only |
| Address match | false, execute_only | false, execute_only |
| Document authenticated | true, affects_verification_status | true, affects_verification_status |
| Face similarity | ||
| Person alive | ||
| Selfie authenticity | ||
| Threshold: Similarity | 10% | 10% |
| Threshold: Selfie authenticity | ||
| Threshold: Document authenticity | ||
| Threshold: Liveness check | 10% | 10% |
| Threshold: Name match | 10% | 10% |
| 00000001-0001-0002-0001-200000000007 | 00000000-0001-0002-0001-200000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Single device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/✓ |
| Matcher level | Developer | Developer |
| Country ID list | ||
| Name verification | false, execute_only | false, execute_only |
| Document number | false, execute_only | false, execute_only |
| Date of birth | false, execute_only | false, execute_only |
| Date of expiry | false, execute_only | false, execute_only |
| Document supported | false, execute_only | false, execute_only |
| Address match | false, execute_only | false, execute_only |
| Document authenticated | false, execute_only | false, execute_only |
| Face similarity | false, execute_only | false, execute_only |
| Person alive | false, execute_only | false, execute_only |
| Selfie authenticity | false, execute_only | false, execute_only |
| Threshold: Similarity | 10% | 10% |
| Threshold: Selfie authenticity | 10% | 10% |
| Threshold: Document authenticity | 10% | 10% |
| Threshold: Liveness check | 10% | 10% |
| Threshold: Name match | 10% | 10% |
| 00000001-0001-0002-0002-200000000007 | 00000000-0001-0002-0002-200000000007 | |
|---|---|---|
| Mobile handoff support | Multi device | Single device |
| Services: Doc ID/FaceID | ✓/✓ | ✓/✓ |
| Matcher level | UAT | UAT |
| Country ID list | ||
| Name verification | true, affects_verification_status | true, affects_verification_status |
| Document number | false, execute_only | false, execute_only |
| Date of birth | true, execute_only | true, execute_only |
| Date of expiry | true, affects_verification_status | true, affects_verification_status |
| Document supported | true, affects_verification_status | true, affects_verification_status |
| Address match | false, execute_only | false, execute_only |
| Document authenticated | false, execute_only | false, execute_only |
| Face similarity | true, affects_verification_status | true, affects_verification_status |
| Person alive | true, affects_verification_status | true, affects_verification_status |
| Selfie authenticity | true, affects_verification_status | true, affects_verification_status |
| Threshold: Similarity | 70% | 70% |
| Threshold: Selfie authenticity | 80% | 80% |
| Threshold: Document authenticity | 65% | 65% |
| Threshold: Liveness check | 90% | 90% |
| Threshold: Name match | ||