> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Lookup 3DS > Using device collection data, performs a lookup for an External Card Transfer 3DS authentication. The results will indicate whether the transfer is successfully authenticated or if a 3DS challenge is required. ## OpenAPI ````yaml openapi.json post /external_cards/lookup_3ds openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.214.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /external_cards/lookup_3ds: post: tags: - External Cards summary: Lookup 3DS description: > Using device collection data, performs a lookup for an External Card Transfer 3DS authentication. The results will indicate whether the transfer is successfully authenticated or if a 3DS challenge is required. operationId: lookup3DS parameters: - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/lookup_3ds_request' description: Details of the External Card Transfer 3DS authentication lookup. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/lookup_3ds_response' description: External Card Transfer 3DS authentication lookup complete '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessable_entity' '500': $ref: '#/components/responses/internal_server_error' components: parameters: idempotency_key: description: >- An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry. in: header name: Idempotency-Key schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string schemas: lookup_3ds_request: discriminator: mapping: BROWSER: $ref: '#/components/schemas/lookup_3ds_request_browser' SDK: $ref: '#/components/schemas/lookup_3ds_request_sdk' propertyName: device_channel oneOf: - $ref: '#/components/schemas/lookup_3ds_request_browser' - $ref: '#/components/schemas/lookup_3ds_request_sdk' type: object lookup_3ds_response: description: >- Details for an External Card Transfer 3-D Secure Authentication lookup response properties: challenge_payload: description: 3DS challenge payload, returned if challenge is required type: string challenge_url: description: 3DS challenge URL, returned if challenge is required format: uri type: string id: description: The unique identifier of the 3DS authentication example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string processor_transaction_id: description: Processor Transaction ID, returned if challenge is required type: string status: description: Status of the 3DS authentication enum: - CHALLENGE_REQUIRED - FAILED - NOT_ENROLLED - SUCCESS - UNKNOWN type: string required: - id - status type: object lookup_3ds_request_browser: allOf: - properties: device_details: $ref: '#/components/schemas/device_details' type: object - $ref: '#/components/schemas/lookup_3ds_request_base' description: >- Details for an External Card Transfer 3-D Secure Authentication lookup request using a browser title: Browser type: object lookup_3ds_request_sdk: allOf: - $ref: '#/components/schemas/lookup_3ds_request_base' description: >- Details for an External Card Transfer 3-D Secure Authentication lookup request using a SDK title: SDK type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object device_details: description: >- Optionally provided browser device details, used as a fallback in case there is an issue with Device Data Collection. Note that minimal field validation is performed. properties: color_depth: description: The device's color palette bit depth, in bits per pixel example: 24 maximum: 99 minimum: 1 type: integer header: description: The exact contents of the browser's HTTP accept headers example: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 type: string ip_address: description: The device's IP address (either IPv4 or IPv6 formats are acceptable) example: 1.12.123.255 type: string java_enabled: description: >- If the browser has the ability to execute Java (value returned from `navigator.javaEnabled` property) type: boolean javascript_enabled: description: >- If the browser has the ability to execute JavaScript (value returned from `navigator.javaScriptEnabled` property) type: boolean language: description: The browser's language as defined in IETF BCP47 example: en-US type: string screen_height: description: The total height of the device's screen, in pixels example: 1080 maximum: 999999 minimum: 1 type: integer screen_width: description: The total width of the device's screen, in pixels example: 1920 maximum: 999999 minimum: 1 type: integer timezone: description: The offset from UTC of the device's local timezone, in minutes example: -300 maximum: 840 minimum: -840 type: integer user_agent: description: The exact contents of the HTTP user agent header example: >- Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36 type: string required: - color_depth - header - ip_address - java_enabled - javascript_enabled - language - screen_height - screen_width - timezone - user_agent type: object lookup_3ds_request_base: description: >- Details for an External Card Transfer 3-D Secure Authentication lookup request properties: authentication_indicator: enum: - INSTALLMENT - PAYMENT - RECURRING type: string device_channel: description: | Channel through which Device Data Collection was performed Channel | Description --- | --- `BROWSER` | Internet browser `SDK` | Mobile app enum: - BROWSER - SDK example: BROWSER type: string id: description: The unique identifier of the 3DS authentication example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string transaction_mode: enum: - COMPUTER_DEVICE - MOBILE_DEVICE - TABLET_DEVICE type: string required: - authentication_indicator - device_channel - id - transaction_mode type: object responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error unprocessable_entity: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity request response internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````