Verify sender for project

Verify sender for project
GA

Request

Verifies sender with the OTP code received after triggering registration.

Security

BasicAuth and BearerAuth and OAuth2Production

Path

projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

plusFriendIdstringrequired

The unique ID of the sender.

Bodyapplication/jsonrequired

Verify sender data

codenumberrequired

Numeric code to verify the sender.

Example:123456

Example body request to verify.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": 123456
  }'

Responses

Sender

Bodyapplication/json

plusFriendIdstringrequired

PlusFriend ID

idstring

The unique ID of the sender.

statestring(KakaotalkSenderStates)

The current state of the sender.

Enum:"ACTIVE""BLOCKED""INACTIVE""SUSPENDED""VERIFYING"

changesobject(KakaotalkSenderChangesDto)

Any pending changes to the sender.

detailsobject(KakaotalkSenderDetailsDto)

Sender details and information.

createdstring

The UTC Date Time in ISO 8601 for when the sender was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the sender was last modified.

Response

Response when successfully verified a sender.

{
  "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  "state": "ACTIVE",
  "details": {
    "adminPhoneNo": "+48777777777",
    "name": "Test Name",
    "logoImage": "https://example-logo-image.com",
    "topLevelCategoryCode": "019",
    "midLevelCategoryCode": "0006",
    "subLevelCategoryCode": "0001"
  },
  "created": "2023-02-23T11:28:51.194Z",
  "modified": "2023-02-23T11:28:51.194Z"
}