AlmondTill/G3N API

Verify your identity as an owner

Owning an organization asks a one-time identity check — see where yours stands and begin or pick it back up on the secure page; once verified you are never asked again.

Manage · a play in 2 steps.

The steps

  1. See where your check stands. — myIdentityVerification
  2. Begin, or pick it back up — once verified, never asked again. — startIdentityVerification

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

myIdentityVerification

myIdentityVerification — query · Your own identity-verification standing — whether owning an organization asks it of you, where the check stands, and the verified-forever fact once it lands.

Example request

query ExampleMyIdentityVerification {
  myIdentityVerification {
    required
    status
    sessionRef
    requestedAt
    updatedAt
    verifiedAt
    lastErrorCode
    lastErrorReason
    aged
  }
}

Example response

{
  "data": {
    "myIdentityVerification": {
      "required": true,
      "status": "<status>",
      "sessionRef": "<session ref>",
      "requestedAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "verifiedAt": "2027-01-31T00:00:00.000Z",
      "lastErrorCode": "BJ-001",
      "lastErrorReason": "<last error reason>",
      "aged": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

startIdentityVerification

startIdentityVerification — mutation · Begin — or pick back up — your identity verification through Stripe; answers the secure Stripe page to complete it on.

Example request

mutation ExampleStartIdentityVerification {
  startIdentityVerification {
    status
    sessionRef
    url
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "startIdentityVerification": {
      "status": "<status>",
      "sessionRef": "<session ref>",
      "url": "https://example.com/hook"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}