For the complete documentation index, see llms.txt. This page is also available as Markdown.

Check KYC data completeness

Pure read of the last handoff attempt's verdict on the shared-token path; use it as a fallback to the fma.kyc.reuse_check.result webhook. Poll every 30 seconds to 2 minutes and stop after submit succeeds. An incomplete session returns code 20004 with missingFields.

post
/api/fma/v1/kyc/check
Authorizations
X-Api-SignaturestringRequired

Partner Auth: EIP-191 signature by the partner's registered backend key, with X-Api-Deadline and optional X-Api-PublicKey headers. See the Signature and verify guide.

Header parameters
X-Ur-IdstringOptional

The user's URID. Send at least one of X-Ur-Id or X-External-User-Id.

X-External-User-IdstringOptional

Your partner-side user id. Send at least one of X-Ur-Id or X-External-User-Id.

X-Api-SignaturestringRequired

Partner Auth EIP-191 signature over the canonical message plus the deadline.

X-Api-DeadlinestringRequired

Unix timestamp in seconds after which the signature is no longer valid.

X-Api-PublicKeystringRequired

Partner public key used to verify the signature.

Body
sessionIdstringRequired

The onboarding session UUID returned by create-account.

Responses
200

Business result envelope. code 0 means success; business rejections return HTTP 200 with a non-zero code.

application/json
codeintegerOptional

Business result code. 0 means success; business rejections return HTTP 200 with a non-zero code.

messagestringOptional

Human-readable diagnostic for non-zero codes.

post/api/fma/v1/kyc/check
POST /api/fma/v1/kyc/check HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
X-Api-PublicKey: text
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "sessionId": "223d567f-ea11-4629-ba2a-94664edc26f6"
}
200

Business result envelope. code 0 means success; business rejections return HTTP 200 with a non-zero code.

{
  "code": 0,
  "message": "",
  "data": {
    "state": "SignFormA",
    "complete": true
  }
}

Last updated