Skip to main content
POST
/
v1
/
tags
Create a new tag
curl --request POST \
  --url https://idaas.yourflexpay.com/api/v1/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tag": "<string>",
  "subjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "message": "<string>",
  "errorCode": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tagString": "<string>",
    "qualifiedAddress": "<string>",
    "status": "ACTIVE",
    "canonicalOwner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationName": "<string>",
      "externalId": "<string>",
      "displayName": "<string>",
      "email": "<string>",
      "imageUrl": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "createdByAppId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdByAppName": "<string>",
    "activeClaims": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tagId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tagString": "<string>",
        "subjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "subjectExternalId": "<string>",
        "requestedByAppId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "requestedByAppName": "<string>",
        "state": "PENDING",
        "requestedAt": "2023-11-07T05:31:56Z",
        "approvedAt": "2023-11-07T05:31:56Z",
        "revokedAt": "2023-11-07T05:31:56Z",
        "consentToken": "<string>",
        "approvalUrl": "<string>",
        "tokenExpiresAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "errors": [
    "<string>"
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Obtain a token from POST /v1/auth/token using your client_id and client_secret, then enter Bearer <token> here.

Body

application/json
​
tag
string
required
Required string length: 3 - 64
Pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
​
subjectId
string<uuid>
required

Response

200 - */*

OK

​
success
boolean
​
message
string
​
errorCode
string
​
data
object
​
errors
string[]
​
timestamp
string<date-time>