Bynn Intelligence

Bynn Intelligence Nfc API

Operations about nfcs

GitHub OpenAPI

Operations 1

POST /nfc NFC data submission #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/bynn-com/openapi/bynn-com-nfc-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/bynn-com/json-schema/bynn-com-post-nfc-schema.json
📊
JSONSchema
https://artifacts.apis.io/bynn-com/json-schema/bynn-com-post-documents-schema.json
📊
JSONSchema
https://artifacts.apis.io/bynn-com/json-schema/bynn-com-bynn-v1-entities-moderation-model-entity-schema.json
📊
JSONSchema
https://artifacts.apis.io/bynn-com/json-schema/bynn-com-bynn-v1-entities-auto-doc-invitation-schema.json
📊
JSONSchema
https://artifacts.apis.io/bynn-com/json-schema/bynn-com-bynn-v1-entities-dossier-entity-schema.json
📊
JSONSchema
https://artifacts.apis.io/bynn-com/json-schema/bynn-com-bynn-v1-entities-age-verification-result-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bynn-com:bynn-com-nfc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bynn-com-nfc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BYNN Nfc API
  description: 'The BYNN API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects. To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no “switch” for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test-mode credentials never hit live networks and incur no cost. **AUTHENTICATION:** Use your **Private API Key**, which looks like `private_xxxxxxxxxxxxxxxxxxxxxxxx` (or `private_sandbox_xxxxxxxxxxxxxxxxxxxxxxxx` for a sandbox key), as the username in HTTP Basic auth with an empty password, or send it as `Authorization: Bearer `. Your keys are at https://dashboard.bynn.com/integration.'
  termsOfService: https://bynn.com/terms
  contact:
    name: BYNN Development Team
    email: hello@bynn.com
    url: https://docs.bynn.com
  license:
    name: BYNN Documentation
    url: https://docs.bynn.com
  version: '1.0'
servers:
- url: https://api.bynn.com/v1
tags:
- name: nfc
  description: Operations about nfcs
paths:
  /nfc:
    post:
      summary: NFC data submission
      description: Submit NFC-scanned identity document data from mobile device NFC reader to the session.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postNfc'
        required: true
      responses:
        '201':
          description: NFC data submission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bynn_V1_Entities_LivenessStart'
        '400':
          description: Invalid NFC data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bynn_V1_Entities_Error'
        '404':
          description: Invalid session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bynn_V1_Entities_Error'
        '422':
          description: NFC data validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bynn_V1_Entities_Error'
      tags:
      - nfc
      operationId: postNfc
components:
  schemas:
    postNfc:
      type: object
      properties:
        session_id:
          type: string
          description: Unique session token
        can:
          type: string
          description: Card Access Number (CAN) for PACE authentications.
        authenticationStatus:
          type: object
          description: Authentication status from NFC chip
          properties:
            chipAuth:
              type: boolean
              description: Chip authentication status
            paceAuth:
              type: boolean
              description: PACE authentication status
            passiveAuth:
              type: boolean
              description: Passive authentication status
          required:
          - chipAuth
          - paceAuth
          - passiveAuth
        cameraImage:
          type: string
          description: Base64 strict encoded camera image of the document
        faceImageBase64:
          type: string
          description: Base64 strict encoded face image from NFC chip
        certificateInfo:
          type: object
          description: Document certificate information
          properties:
            documentSignerCertificate:
              type: object
              description: Document signer certificate details
              properties:
                algorithm:
                  type: string
                  description: Certificate algorithm
                issuer:
                  type: string
                  description: Certificate issuer
                serialNumber:
                  type: string
                  description: Certificate serial number
                subject:
                  type: string
                  description: Certificate subject
                validFrom:
                  type: string
                  description: Certificate valid from date
                validTo:
                  type: string
                  description: Certificate valid to date
        dateOfBirth:
          type: string
          description: Date of birth (YYMMDD format)
        dateOfExpiry:
          type: string
          description: Document expiry date (YYMMDD format)
        documentNumber:
          type: string
          description: Document number
        gender:
          type: string
          description: Gender
          enum:
          - MALE
          - FEMALE
          - OTHER
        givenNames:
          type: string
          description: Given names from document
        surname:
          type: string
          description: Surname from document
        nationality:
          type: string
          description: Nationality code (3-letter)
        issuer:
          type: string
          description: Document issuing country code (3-letter)
        personalNumber:
          type: string
          description: Personal identification number
        hashVerification:
          type: object
          description: Hash verification data
          properties:
            algorithmUsed:
              type: string
              description: Hash algorithm used
            dg1Hash:
              type: string
              description: Base64 strict Data Group 1 hash
            dg2Hash:
              type: string
              description: Base64 strict Data Group 2 hash
            dg3Hash:
              type: string
              description: Base64 strict Data Group 3 hash
            dg4Hash:
              type: string
              description: Base64 strict Data Group 4 hash
            dg5Hash:
              type: string
              description: Base64 strict Data Group 5 hash
            dg6Hash:
              type: string
              description: Base64 strict Data Group 6 hash
            dg7Hash:
              type: string
              description: Base64 strict Data Group 7 hash
            dg8Hash:
              type: string
              description: Base64 strict Data Group 8 hash
            dg9Hash:
              type: string
              description: Base64 strict Data Group 9 hash
            dg10Hash:
              type: string
              description: Base64 strict Data Group 10 hash
            dg11Hash:
              type: string
              description: Base64 strict Data Group 11 hash
            dg12Hash:
              type: string
              description: Base64 strict Data Group 12 hash
            dg13Hash:
              type: string
              description: Base64 strict Data Group 13 hash
            dg14Hash:
              type: string
              description: Base64 strict Data Group 14 hash
            dg15Hash:
              type: string
              description: Base64 strict Data Group 15 hash
            dg16Hash:
              type: string
              description: Base64 strict Data Group 16 hash
            faceImageHash:
              type: string
              description: Base64 strict Face image hash
            sodHash:
              type: string
              description: Base64 strict Security Object Data hash
          required:
          - algorithmUsed
          - dg1Hash
          - dg2Hash
          - dg14Hash
          - faceImageHash
          - sodHash
        locationData:
          type: object
          description: Location data
          properties:
            accuracy:
              type: number
              format: float
              description: Location accuracy in meters
            altitude:
              type: number
              format: float
              description: Altitude in meters
            latitude:
              type: number
              format: float
              description: Latitude coordinate
            longitude:
              type: number
              format: float
              description: Longitude coordinate
            provider:
              type: string
              description: Location provider
              enum:
              - gps
              - network
              - passive
            timestamp:
              type: integer
              format: int32
              description: Location timestamp in milliseconds
        mrzData:
          type: string
          description: Complete MRZ data as multi-line string
        rawDG1:
          type: string
          description: Data Group 1 - MRZ information
        rawDG2:
          type: string
          description: Data Group 2 - Encoded face image (Biometrics)
        rawDG3:
          type: string
          description: Data Group 3 - Fingerprint data (Biometrics)
        rawDG4:
          type: string
          description: Data Group 4 - Iris data (Biometrics)
        rawDG5:
          type: string
          description: Data Group 5 - Displayed portrait
        rawDG6:
          type: string
          description: Data Group 6 - Reserved for future use
        rawDG7:
          type: string
          description: Data Group 7 - Displayed signature
        rawDG8:
          type: string
          description: Data Group 8 - Data features
        rawDG9:
          type: string
          description: Data Group 9 - Structure features
        rawDG10:
          type: string
          description: Data Group 10 - Substance features
        rawDG11:
          type: string
          description: Data Group 11 - Additional personal details
        rawDG12:
          type: string
          description: Data Group 12 - Additional document details
        rawDG13:
          type: string
          description: Data Group 13 - Optional details
        rawDG14:
          type: string
          description: Data Group 14 - Security infos
        rawDG15:
          type: string
          description: Data Group 15 - Active authentication public key
        rawDG16:
          type: string
          description: Data Group 16 - Persons to notify
        rawSOD:
          type: string
          description: SOD - Security Object Data
      required:
      - authenticationStatus
      - faceImageBase64
      - dateOfBirth
      - dateOfExpiry
      - documentNumber
      - gender
      - givenNames
      - surname
      - nationality
      - issuer
      - hashVerification
      - rawDG1
      - rawDG2
      - rawDG14
      - rawDG15
      - rawSOD
      description: NFC data submission
    Bynn_V1_Entities_LivenessSession:
      type: object
      properties:
        session_id:
          type: string
          description: Liveness session identifier
        credentials:
          allOf:
          - $ref: '#/components/schemas/Bynn_V1_Entities_LivenessCredentials'
          description: Credentials
        server_time:
          type: integer
          format: int32
          description: Server time in milliseconds
      required:
      - session_id
      - credentials
      - server_time
    Bynn_V1_Entities_Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: validation_error
              description: Type of error
            message:
              type: string
              example: Invalid parameters
              description: Error message
            reason:
              type: string
              example: issuer_key_unavailable
              description: Machine-readable cause, where one is set
            retry_after:
              type: integer
              format: int32
              example: 60
              description: Seconds to wait before retrying
            limit:
              type: integer
              format: int32
              example: 30
              description: The limit that was exceeded
            detail:
              type: string
              description: Operator-facing detail, outside production
          required:
          - type
          - message
      required:
      - error
      description: Bynn_V1_Entities_Error model
    Bynn_V1_Entities_LivenessStart:
      type: object
      properties:
        age_verification_id:
          type: string
          description: Age Verification ID
        liveness_session:
          allOf:
          - $ref: '#/components/schemas/Bynn_V1_Entities_LivenessSession'
          description: Liveness session information
      required:
      - age_verification_id
      - liveness_session
      description: Bynn_V1_Entities_LivenessStart model
    Bynn_V1_Entities_LivenessCredentials:
      type: object
      properties:
        id:
          type: string
          description: Access ID
        access_key:
          type: string
          description: Access Key
        token:
          type: string
          description: Access Session Token
      required:
      - id
      - access_key
      - token
  securitySchemes:
    PrivateKey:
      type: apiKey
      name: Authorization
      in: header
      description: Enter your PRIVATE KEY token prefixed with `Bearer `, e.g. `Bearer your_token_here`
    PublicKey:
      type: apiKey
      name: Authorization
      in: header
      description: Enter your PUBLIC KEY token prefixed with `Bearer `, e.g. `Bearer your_token_here`